Intellij idea 在Javadoc IntelliJ中编辑字段

Intellij idea 在Javadoc IntelliJ中编辑字段,intellij-idea,javadoc,Intellij Idea,Javadoc,我对java相当陌生,在我的一个作业中,我正在研究如何为每个类中的方法添加信息。我正在使用IntelliJ Idea编辑器 下面是一个使用JavaDoc的示例 import java.io.*; /** *加两个数字! *AddNum程序实现了一个 *只需将两个给定的整数相加即可打印 *屏幕上的输出。 * *注意:在你的程序中给出适当的注释会使它更加 *用户友好,被认为是高质量的代码。 * *@作者扎拉·阿里 *@version 1.0 *@自2014年3月31日起 */ 公共类AddNum{

我对java相当陌生,在我的一个作业中,我正在研究如何为每个类中的方法添加信息。我正在使用IntelliJ Idea编辑器

下面是一个使用JavaDoc的示例

import java.io.*;
/**
*加两个数字!
*AddNum程序实现了一个
*只需将两个给定的整数相加即可打印
*屏幕上的输出。
*
*注意:在你的程序中给出适当的注释会使它更加
*用户友好,被认为是高质量的代码。
*
*@作者扎拉·阿里
*@version 1.0
*@自2014年3月31日起
*/
公共类AddNum{
/**
*此方法用于添加两个整数。这是
*类方法的最简单形式,只是为了
*显示各种javadoc标记的用法。
*@param numA这是addNum方法的第一个参数
*@param numB这是addNum方法的第二个参数
*@return int返回numA和numB之和。
*/
public int addNum(int numA,int numB){
返回numA+numB;
}
/**
*这是使用addNum方法的主要方法。
*@param args未使用。
*@一无所获。
*@exception-IOException输入错误。
*@见IOException
*/
公共静态void main(字符串args[])引发IOException
{
AddNum obj=新的AddNum();
int sum=obj.addNum(10,20);
System.out.println(“10和20之和为:“+Sum”);
}
}
Intellij IDEA中添加所有文档信息后,转到工具->生成JavaDoc…,然后指定输出目录,然后单击确定

以下是有关如何在IDEA-

还可以看一下Oracle的样式指南如何为Javadoc工具编写文档注释


祝你好运

你的问题到底是什么?要添加javadoc,您需要编写它,如文档所示:
import java.io.*;

/**
* <h1>Add Two Numbers!</h1>
* The AddNum program implements an application that
* simply adds two given integer numbers and Prints
* the output on the screen.
* <p>
* <b>Note:</b> Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31
*/
public class AddNum {
   /**
   * This method is used to add two integers. This is
   * a the simplest form of a class method, just to
   * show the usage of various javadoc Tags.
   * @param numA This is the first paramter to addNum method
   * @param numB  This is the second parameter to addNum method
   * @return int This returns sum of numA and numB.
   */
   public int addNum(int numA, int numB) {
      return numA + numB;
   }

   /**
   * This is the main method which makes use of addNum method.
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {

      AddNum obj = new AddNum();
      int sum = obj.addNum(10, 20);

      System.out.println("Sum of 10 and 20 is :" + sum);
   }
}