Шрифт:
Этот дескриптор предназначен для документирования классов, реализующих интерфейс Serializable. Он предоставляет комментарии к компоненту ObjectStreamField. У этого дескриптора имеется следующий синтаксис: 0serialField имя тип описание где имя и тип обозначают конкретное наименование и тип поля соответственно, а описание — комментарии к этому полю. Дескриптор @since
Дескриптор @since устанавливает, что данный элемент был внедрен, начиная с указанной версии программы. Синтаксис этого дескриптора приведен ниже. 0since версия Здесь версия обозначает символьную строку, указывающую версию или выпуск программы, где был внедрен данный элемент. Дескриптор @throws
Дескриптор @throws выполняет те же действия, что и дескриптор @exception. Дескриптор @value
Этот дескриптор применяется в двух основных формах. В первой форме отображается значение константы, которой предшествует этот дескриптор. Константа должна быть полем типа static. Ниже приведена первая форма этого дескриптора. {@value} Во второй форме отображается значение указываемого статического поля. Эта форма выглядит следующим образом: {@value пакет.класс#член } где пакет. класс#член обозначает имя статического поля. Дескриптор @version
Дескриптор (Aversion описывает версию класса. Ниже приведен синтаксис этого дескриптора. 0 vers ion информация Здесь информация обозначает символьную строку, содержащую сведения о версии программы. Как правило, это номер версии, например 2.2. Для того чтобы сведения в поле дескриптора 0 vers ion были включены в результирующий HTML-документ, при вызове утилиты javadoc из командной строки следует указать параметр -version. Общая форма документирующих комментариев
После символов / следует одна или несколько строк с общим описанием класса, интерфейса, переменной или метода. Далее можно ввести любое количество дескрипторов, начинающихся со знака @. Каждый такой дескриптор должен начинаться с новой строки или следовать после одной или нескольких звездочек (*) в начале строки. Несколько однотипных дескрипторов должны быть объединены вместе. Так, если требуется использовать три дескриптора 0see, их следует расположить друг за другом. Встраиваемые дескрипторы (начинающиеся с фигурной скобки) можно применять в любом описании. Ниже приведен пример, демонстрирующий применение документирующих комментариев для описания класса. /
Класс для отображения гистограммы.
0author Herbert Schildt
0version 3.2 */ Результат, выводимый утилитой javadoc
Утилита javadoc читает данные из исходного файла программы на Java и формирует несколько HTML-файлов, содержащих документацию на эту программу. Сведения о каждом классе помещаются в отдельный файл. В результате выполнения утилиты javadoc составляется также предметный указатель и дерево иерархии. Кроме того, могут быть сформированы и другие HTML-файлы. Пример применения документирующих
комментариев Ниже приведен пример программы, в исходном тексте которой имеются документирующие комментарии. Обратите внимание на то, что каждый такой комментарий непосредственно предшествует описываемому элементу программы. После обработки утилитой javadoc документация на класс SquareNum помещается в файл SquareNum.html. import java.io.; /
Класс, демонстрирующий применение документирующих комментариев.
Этот метод возвращает квадрат значения параметра num.
Это описание состоит из нескольких строк. Число строк
не ограничивается.
/ public double square(double num) { return num num; } I -к -кЭтот метод получает значение, введенное пользователем.
/ public double getNumber throws IOException { // создать поток BufferedReader из стандартного потока System.in. InputStreamReader isr = new InputStreamReader(System.in); BufferedReader inData = new BufferedReader(isr); String str; str = inData.readLine ; return (new Double(str)).doubleValue ; } 6X В этом методе демонстрируется применение метода square.@param args Не используется.
0exception IOException Исключение при ошибке ввода.
@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); } }