Javadoc Java Advanced

2Georgiy KorneevJava Advanced / Javadoc Содержание 1.Структура Javadoc 2.Блочные тэги 3.Строчные тэги 4.Применение Javadoc 5.Компиляция Javadoc 6.Заключение

3Georgiy KorneevJava Advanced / Javadoc Что такое Javadoc Способ документирования программ Инструмент для генерирования документации Сгенерированная документация

Структура Javadoc Часть 1

5Georgiy KorneevJava Advanced / Javadoc Javadoc-комментарии Обыкновенный комментарий /* Calculates the factorial */ int factorial(int x) { … Javadoc-комментарий /** Calculates the factorial */ public double factorial(int x) { …

6Georgiy KorneevJava Advanced / Javadoc Применение Javadoc-комментариев Описание пакетов классов методов конструкторов полей

7Georgiy KorneevJava Advanced / Javadoc Структура Javadoc-комментария /** * Краткое описание. Основное описание * * Блок тегов */

8Georgiy KorneevJava Advanced / Javadoc Пример Javadoc-комментария /** * Calculates the factorial. For negative numbers * returns 1. * x a value the factorial of x */ public double factorial(int x) {

9Georgiy KorneevJava Advanced / Javadoc Типы тегов Блочные теги Начинается и оканчивается с началом следующего тега x a value Строчные теги Ограничены фигурными скобками Могут встречаться в теле других тегов Пример Use a java.lang.Math#log} for positive numbers.

Блочные теги Часть 2

11Georgiy KorneevJava Advanced / Javadoc Описывает параметры методов и конструкторов x a value

12Georgiy KorneevJava Advanced / Javadoc Описывает возвращаемое значение метода the factorial of x

13Georgiy KorneevJava Advanced / Javadoc Описывает исключения, генерируемые методом/конструктором IllegalArgumentException if x is less than zero

14Georgiy KorneevJava Advanced / Javadoc Ссылка на дополнительную [ " " "The Java Programming language Specification, p. 142"

15Georgiy KorneevJava Advanced / Javadoc Текущая версия класса/пакета 5.0

16Georgiy KorneevJava Advanced / Javadoc Версия в которой была добавлена описываемая сущность 5.0

17Georgiy KorneevJava Advanced / Javadoc Помечает возможности, которые не следует использовать replaced by #setVisible}

18Georgiy KorneevJava Advanced / Javadoc Описывает автора класса/пакета Josh Neal Gafter

Строчные теги Часть 3

20Georgiy KorneevJava Advanced / Javadoc Тэг Ссылка на другую сущность Синтаксис # } Примеры java.lang.Math#Log10 Decimal Logarithm} Math} Math#Log10} #factorial() calculates factorial}

21Georgiy KorneevJava Advanced / Javadoc Тэг Заменяется на ссылку на корень документации Синтаксис Пример Copyright

22Georgiy KorneevJava Advanced / Javadoc Тэг Заменяется на значение поля Синтаксис # } Пример Default value is #DEFAULT_TIME}

23Georgiy KorneevJava Advanced / Javadoc Тэг Предназначен для вставки фрагментов кода Внутри тэга HTML не распознается Синтаксис } Пример Is equivalent of Math.max(a, b)}.

Применение Javadoc Часть 4

25Georgiy KorneevJava Advanced / Javadoc Где могут быть использованы тэги ПакетыКлассыМетоды и

26Georgiy KorneevJava Advanced / Javadoc Описание пакета Хранится в файле package.html в этом пакете Описание – часть заключенная в теги

27Georgiy KorneevJava Advanced / Javadoc Наследование Javadoc Если какая-то часть информации о методе не указана, то описание копируется у ближайшего предка Копируемая @throws

Компиляция Javadoc Часть 5

29Georgiy KorneevJava Advanced / Javadoc Компиляция Javadoc Инструмент Javadoc Применение javadoc Пример javadoc JavadocExample1.java

30Georgiy KorneevJava Advanced / Javadoc Основные опции Javadoc -sourcepath Местоположения исходных фалов -classpath Местоположение используемых классов -d Каталог для документации -publicПодробность информации -protected -package -private -versionИнформация о версии -authorИнформация об авторе

Заключение Часть 6

32Georgiy KorneevJava Advanced / Javadoc Ссылки Javadoc Tool // How to Write Doc Comments for the Javadoc Tool // mments/index.html mments/index.html Javadoc FAQ // ml ml

33Georgiy KorneevJava Advanced / Javadoc Вопросы