211
При попытке создать пакетный комментарий Javadoc, какой предпочтительный метод? Чем ты занимаешься?Javadoc: package.html или package-info.java
package-info.java
- Pros
- Новые
- Против
- Злоупотребление класса - Классы для кода, а не только для комментариев
package.html
- Pros
- расширение HTML означает, что его не код
- Подсветка синтаксиса в/текстовых редакторов среды IDE
- Cons
- Нет?
Для меня, я всегда Package.html. Но мне интересно, правильный ли выбор.
'package-info.java' может содержать аннотации [package] - это не обязательно все документы API. –
Я бы не квалифицировал package-info.java как злоупотребление классом. Это исходный файл java (имеет расширение «.java»), но не является файлом класса, поскольку он не содержит объявления класса. И, фактически, он не может содержать объявление класса, потому что «package-info» не является именем юридического класса. – Scrubbie
Другой причиной использования package-info.java вместо package.html может быть то, что .java не подразумевает конкретный формат вывода документации. Например, вы можете вывести javadoc как LaTeX или как файл PDF. В зависимости от реализации компилятора javadoc это может вызвать проблемы в случае .html. – honeyp0t