Читать «Java: руководство для начинающих» онлайн - страница 379

Класс для отображения гистограммы.

0author Herbert Schildt

0version 3.2 */ Результат, выводимый утилитой javadoc

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

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

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

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

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

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

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

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