Java 8 — пользовательская проверка JavaDoc с использованием Doclet

Меня интересует проверка JavaDoc, я нашел этот ответ о настройке проверяет:

import com.sun.javadoc.*;

public class CheckingDoclet extends Doclet {

Проблема com.sun.javadoc была удалена и будет заменена только в java 9 (что означает использование как минимум java 10)

Объявления в этом пакете заменены объявлениями в пакете jdk.javadoc.doclet. Дополнительные сведения см. в Руководстве по миграции в документации к этому пакету.

Есть ли замена с использованием Java 8?

ИЗМЕНИТЬ

Мне нужна новая проверка для предотвращения описания после тега блока,

В чекстайле такого правила нет и нужно создать новый чек

В PMD такого правила нет и, вероятно, нужно создать новую проверку


java java-8 javadoc doclet
person user7294900    schedule 11.10.2018    source источник
comment
Как насчет checkstyle.sourceforge.net/writingchecks.html   -  person PowerStat    schedule 11.10.2018
comment
@PowerStat Это мой единственный вариант? можно уточнить ответ?   -  person user7294900    schedule 11.10.2018
comment
Я не знаю другого способа или инструмента, кроме как попросить сообщество CheckStyle/PMD найти кого-то, кто реализует проверку по вашим требованиям. Может есть плагины, о которых я не знаю.   -  person PowerStat    schedule 11.10.2018

Ответы (1)


arrow_upward
1
arrow_downward

Я бы предложил использовать проверки JavaDoc вашего ide (у меня eclipse), а также CheckStyle и PMD.

Для всех трех вы должны сделать свою собственную конфигурацию!

В eclipse вы можете найти конфигурацию для JavaDocs в Windows/Preferences/Java/Compiler/Javadoc.

Если у вас есть особые требования, которые не могут быть выполнены с помощью этих инструментов, забудьте об eclipse. Ваш единственный шанс — написать собственные расширения для CheckStyle или PMD. Например, см. Написание проверок CheckStyle.

Кстати. также не рекомендуется использовать внутренние API-интерфейсы Java — см. Stackoverflow о доклетах Java 8. Насколько мне известно, эти API исчезнут с Java 9/10/11+. Поэтому не рекомендуется их использовать.

person PowerStat    schedule 11.10.2018
comment
Мне нужна новая проверка для предотвращения описания после тега блока. В стиле проверки необходимо создать новую проверку, см. groups.google.com/forum/#!topic/checkstyle/gsVk6qHeG-k - person user7294900; 11.10.2018
comment
Расширен мой ответ. - person PowerStat; 11.10.2018
comment
Я не знаю, почему вы используете будущее время в «эти API исчезнут с Java 9/10/11+». Java 11 уже выпущен, и этот пакет все еще существует. Кроме того, com.sun.javadoc никогда не был внутренним пакетом. Это был официальный документированный API javadoc и все еще является его частью, даже если мы находимся на этапе перехода к более качественному API. Его удаление не произойдет в ближайшие дни. - person Holger; 11.10.2018
comment
JavaDoc нуждается не только в улучшенном API, но и в выводе, соответствующем стандарту w3c. Кстати. вычеркнули часть моего комментария о внутреннем API. - person PowerStat; 12.10.2018