Как мне документировать пакеты в Java? - PullRequest
Новая
       25

Как мне документировать пакеты в Java?

172 голосов
/ 09 марта 2009

В API Java я вижу комментарии Javadoc для пакетов.

Как / где я могу разместить комментарии Javadoc для документирования пакета?

Ответы [ 3 ]

243 голосов
/ 09 марта 2009

Начиная с 1.5 вы можете определить файл package-info.java и предоставить стандартный комментарий в стиле javadoc для пакета:

COM / Foo / package-info.java: 

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Спецификация языка для пакетов

43 голосов
/ 09 марта 2009

До Java 1.4 вам приходилось предоставлять файл HTML package.html, как описано в других ответах.

Начиная с Java 1.5, вы также можете предоставить package-info.java, который содержит обычный комментарий Javadoc (без HTML). Последний вариант предпочтителен, так как он дает вам некоторые дополнительные функции (в частности, аннотации пакетов).

Подробнее: Документы Sun для Javadoc

4 голосов
/ 09 марта 2009

С файлом package.html на уровне пакета (то есть в каталоге для этого пакета). Это должен быть полностью сформированный файл HTML с тегом <html>, определенным в нем

...