Java Документация Комментарии

Java аннотации только три вида способов. Первые два из них // и / * * /, а третья называется легендой комментарий, который начинается с / **, заканчиваются * /.

Описание Комментарий позволяет вставлять информацию о программе в программе. Вы можете использовать инструмент Javadoc для получения информации и вывод в HTML-файлах.

Описание Комментарий, вы записать больше информации о вашей программе.

Javadoc теги

Javadoc инструмент распознает следующие теги:

Документация Комментарии

После старта / **, первая линия или линии является основным описание классов, переменных и методов.

После этого, вы можете включать в себя один или несколько из какого рода @ тега. @ Каждый тег должен быть на новой строке, или начать в начале строки со звездочкой (*).

Множество того же типа этикетки должны быть помещены в группу. Например, если у вас есть три @see теги, они могут быть объединены по одному.

Ниже приводится описание примера класса комментарий:

/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/

Какой же выход Javadoc

Javadoc инструмент исходный код вашей программы Java в качестве входных данных, вывод некоторых HTML-файл, содержащий вашу программу аннотаций.

Каждый тип информации будет один в HTML-файле. Выход Javadoc также может быть унаследован дерево и индексы.

В связи с различными Javadoc работа реализация может быть разной, вам нужно проверить версию вашей системы разработки Java и другие детали, выберите соответствующую версию Javadoc.

примеров

Ниже приводится комментарий, который объясняет использование простого примера. Обратите внимание, что предыдущий проект каждый аннотацию в его описании.

После лечения Javadoc, примечания класса SquareNum будут найдены в SquareNum.html.

import java.io.*;
 
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a double.
   * @exception IOException On input error.
   * @see IOException
   */
   public double getNumber() throws IOException {
      InputStreamReader isr = new InputStreamReader(System.in);
      BufferedReader inData = new BufferedReader(isr);
      String str;
      str = inData.readLine();
      return (new Double(str)).doubleValue();
   }
   /**
   * This method demonstrates square().
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {
      SquareNum ob = new SquareNum();
      double val;
      System.out.println("Enter value to be squared: ");
      val = ob.getNumber();
      val = ob.square(val);
      System.out.println("Squared value is " + val);
   }
}

Как следует, используя инструмент Javadoc для обработки SquareNum.java файла:

$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
                      in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$