Java руководство для начинающих - Шилдт Герберт (2012)

Утилита javadoc читает данные из исходного файла программы на Java и формирует несколько HTML-файлов, содержащих документацию на эту программу. Сведения

о каждом классе помещаются в отдельный файл. В результате выполнения утилиты

javadoc составляется также предметный указатель и дерево иерархии. Кроме того, могут быть сформированы и другие HTML-файлы.

Пример применения документирующих

комментариев

Ниже приведен пример программы, в исходном тексте которой имеются документирующие комментарии. Обратите внимание на то, что каждый такой комментарий непосредственно предшествует описываемому элементу программы. После обработки утилитой javadoc документация на класс SquareNum помещается в файл SquareNum.html.

import java.io.;

/★

Класс, демонстрирующий применение документирующих комментариев.

©author Herbert Schildt

©version 1.2

*/

public class SquareNum {

I ★ ★

Этот метод возвращает квадрат значения параметра num.

Это описание состоит из нескольких строк. Число строк

не ограничивается.

©param num Значение, которое требуется возвести в квадрат.

©return Квадрат числового значения параметра num.

/

public double square(double num) {

return num num;

}

I -к -к

Этот метод получает значение, введенное пользователем.

©return Введенное значение типа double.

©exception IOException Исключение при ошибке ввода.

©see IOException

/

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);

}

}