English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية
Java поддерживает три способа комментариев. Два первых это // и /* */Восьмым является комментарии-описания, которые начинаются с /** Начало, с */Конец.
Описание комментариев позволяет вам嵌入 информацию о программе в ваш код. Вы можете использовать инструмент javadoc для генерации информации и вывода ее в файлы HTML.
Описание комментариев позволяет вам легко записывать информацию о вашем программном обеспечении.
Инструмент javadoc распознает следующие теги:
| Теги | Описание | Пример |
|---|---|---|
| @автор | Идентифицировать автора класса | @автор описание |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @deprecated |
| @deprecated | 指名一个过期的类或成员 | {@docRoot} |
| 指明当前文档根目录的路径 | @exception | 标志一个类抛出的异常 |
| {@inheritDoc} | 从直接父类继承的注释 | {@link name text} |
| 插入一个到另一个主题的链接 | {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 |
| @param | 说明一个方法的参数 | @return |
| @see | 说明返回值类型 | 指定一个到另一个主题的链接 |
| @see anchor | @serial | 说明一个序列化属性 |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | 标记当引入一个特定的变化时 |
| @throws | 和 @exception标签一样。 | 和 @exception标签一样。 |
| {@value} | 显示常量的值，该常量必须是static属性。 | 显示常量的值，该常量必须是static属性。 |
| @version | 指定类的版本 | @version info |
在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
после которого вы можете включить одну или несколько различных @ метки. Каждый @ метки должны начинаться на новой строке или начинаться с точки и запятой (*).
несколько одинаковых типов меток должны быть размещены вместе. Например, если у вас есть три @see метки, которые можно размещать друг за другом.
Ниже приведен пример комментария с описанием класса:
/*** Этот класс рисует гистограмму * @author w3codebox * @version 1.2 */
Инструмент javadoc принимает в качестве входа исходный код вашего Java программы и выводит некоторые HTML файлы, содержащие комментарии к вашей программе.
Информация о каждом классе будет представлена в отдельном HTML файле. Javadoc также может выводить иерархическую структуру наследования и индекс.
Из-за различий в реализации javadoc результаты могут варьироваться, вам нужно проверить версию вашей Java разработочной системы и другие детали, чтобы выбрать подходящую версию Javadoc.
Ниже приведен пример комментария с описанием. Обратите внимание, что каждый комментарий расположен перед описываемым проектом.
После обработки javadoc комментарии класса SquareNum будут найдены в SquareNum.html.
import java.io.*;
/**
* Этот класс демонстрирует документированные комментарии
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
/**
* Этот метод возвращает квадрат числа.
* Это многострочный описания. Вы можете использовать
* как много строк, вам нужно.
* @param num Значение, которое нужно сложить.
* @return Сложенное число.
*/
public double square(double num) {
return num * num;
}
/**
* Этот метод вводит число от пользователя.
* @return Значение ввода в виде double.
* @exception IOException При ошибке ввода.
* @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();
}
/**
* Этот метод демонстрирует функцию square().
* @param args Не используется.
* @return Ничего.
* @exception IOException При ошибке ввода.
* @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.out.println("Введите значение для возведения в квадрат: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Значение квадратного числа равно " + val);
}
}Как показано ниже, файл SquareNum.java обрабатывается инструментом javadoc:
$ javadoc SquareNum.java Загружается исходный файл SquareNum.java... Конструируется информация Javadoc... Стандартная версия Doclet 1.5.0_13 Строится дерево для всех пакетов и классов... Генерируется SquareNum.html... SquareNum.java:39: предупреждение - тег @return не может быть использован\ в методе с типом возвращаемого значения void. Генерируется файл package-frame.html... Генерируется файл 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 предупреждение $