Может ли конкретное свойство / поле быть ограничено генерацией JavaDocs? - PullRequest
Новая
       61

Может ли конкретное свойство / поле быть ограничено генерацией JavaDocs?

0 голосов
/ 07 октября 2019

У меня есть несколько классов Java, содержащих одно или несколько свойств, которые я хотел бы исключить из JavaDocs при их создании. Я использую 'maven-javadoc-plugin' и не могу найти никакой документации, указывающей, что это возможно.

Есть ли тег, который можно применить в POM, или аннотация, которая может быть размещена на фактическомсвойство в классе Java, чтобы можно было исключить определенные свойства?

Я знаю, что исключения могут быть выполнены на уровне package с использованием тега <excludePackageNames /> в POM. Кроме того, представляется, что определенные классы также могут быть ограничены из JavaDocs с помощью тега <sourceFileExcludes />, если также определен <sourcepath />.

В качестве альтернативы,Я использую RAML 1.0 для создания документации API для этого проекта, поэтому кто-нибудь знает, есть ли исключение, относящееся к RAML, которое можно применить, чтобы предотвратить включение документации? Конечно, JavaDocs генерируются отдельно от документов RAML, поэтому для ограничения свойств / полей отдельных классов на стороне RAML (если это возможно) все равно потребуется исключение JavaDocs, чтобы плагин Maven JavaDocs также игнорировал их.

Заранее спасибо! Хотя я ожидаю, что ответ будет отрицательным.

1 Ответ

0 голосов
/ 09 октября 2019

Вот два возможных решения.

  1. Напишите свой собственный доклет. Документация API (HTML-страницы, описывающие классы Java) генерируется из комментариев Javadoc стандартным доклетом . Этот доклет является открытым исходным кодом. Вы можете скопировать этот доклет, слегка изменить его, а затем запустить измененную версию для создания документации API.

  2. Определить аннотацию @NotDocumented, которая будет отображаться в документации HTML. Напишите аннотацию о «секретных» полях / методах вашего класса. Создайте документацию HTML API нормально. Постобработка документации HTML API с использованием инструмента обработки текста, такого как perl, awk или sed, для удаления всех ссылок на @NotDocumented членов.

...