Документування коду javadoc

При документуванні додатки необхідна також підтримка документації програми. Якщо документація і код розділені, то мимоволі створюються складності, пов'язані з необхідністю внесення змін до відповідних розділів супровідної документації при зміні програмного коду.

Для документування коду можна використовувати HTML теги. При використанні довідкових дескрипторів @see і @link потрібно спочатку вказати ім'я класу і після символу "#" його метод або поле.

Середовище розробки IDE, як правило, допомагає програмісту "підсвічуванням" вбудованої документації. На наступних малюнках наведені скріншоти спливаючих вікон IDE Eclipse.

Утиліта javadoc в якості вхідних даних приймає файл з вихідним кодом програми, для якого генерується НТМ файл. Документація для кожного класу міститься в окремому НТМ файлі. Крім цього, створюється дерево індексів і ієрархії. Можуть бути згенеровані і інші НТМ файли.

Для створення документації можна використовувати ant.

Приклад сценарію (завдання) ant для формування документації до додатка MyProject:

Детальна інформація формування документації представлена ​​на сторінці Javadoc / Javadoc2