在 Javadoc IntelliJ 中编辑字段

Question

我是 java 的新手，我的一项作业正在研究如何为每个类中的方法添加信息。我正在使用 IntelliJ Idea 编辑器。

Answer 1

这里是一个使用 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);
   }
}

在 Intellij IDEA 中添加文档的所有信息后，转到 Tools -> Generate JavaDoc... 然后指定 输出目录点击确定

这里有更详细的关于如何在IDEA中使用Generate JavaDoc Dialog的信息 - https://www.jetbrains.com/idea/help/generate-javadoc-dialog.html

另请查看 Oracle 的样式指南 如何为 Javadoc 工具编写文档注释 - http://www.oracle.com/technetwork/articles/java/index-137868.html

祝你好运！

在 Javadoc IntelliJ 中编辑字段

Editing fields in Javadoc IntelliJ

javadoc

intellij-idea