При попытке создать комментарии на уровне пакета Javadoc, какой метод предпочтительнее? Чем ты занимаешься?
package-info.java
- Pros
- Новее
- Cons
- Злоупотребление классом - классы для кода, а не только для комментариев
package.html
- Pros
- Расширение HTML означает, что это не код
- Подсветка синтаксиса в IDE / текстовых редакторах
- Cons
- Никто?
Для меня я всегда использовал Package.html. Но мне интересно, если это правильный выбор.
Я бы не квалифицировал package-info.java как злоупотребление классом. Это исходный файл Java (с расширением «.java»), но это не файл класса, потому что он не содержит объявления класса. И, фактически, он не может содержать объявление класса, потому что «package-info» не является допустимым именем класса.
—
Скрабби
Другая причина использования package-info.java вместо package.html может заключаться в том, что .java не подразумевает особый формат вывода документации. Например, вы можете вывести Javadoc в виде LaTeX или в виде файла PDF. В зависимости от реализации компилятора javadoc это может вызвать проблемы в случае .html.
—
honeyp0t
На самом деле @Scrubbie - хотя вы должны быть правы, я думаю, вы можете указать там закрытые для пакета классы. :-( Я согласен с вашим мнением, хотя использование
—
mjaggard
package-info.java
Javadoc и аннотаций не является злоупотреблением классом.
@JonasN см stackoverflow.com/a/14708381/751579 (я знаю , что ты имел эту проблему 3 -х лет назад, но , возможно , кто - то нуждается в верхушку сейчас)
—
davidbak
package-info.java
может содержать аннотации [пакета] - это не обязательно все документы API.