Javadoc исключить некоторые публичные методы из класса

Question

Я должен исключить некоторые из открытых методов класса из включения в javadocs. Я попробовал ExcludeDoclet Криса Ноклеберга (шесть ног). Но доклет дает небольшую проблему: Если другие методы в классе возвращают List (или любые другие дженерики), вместо того, чтобы отображаться в javadoc как список, тип возвращаемого значения просто отображается как список (без общей информации)

Может кто-нибудь дать подсказку или обойти, как решить эту проблему?

Answer 1

Я предполагаю, что методы, которые вы хотите исключить из javadoc, являются открытыми методами, которые вы не хотите, чтобы ваш клиент использовал.Другими словами, эти методы устарели .Что вам нужно сделать, это использовать аннотацию @Deprecated.Например:

@Deprecated public void badMethod() {
    ...
}

Теперь метод badMethod () устарел.Если кто-то использует badMethod () в своем коде, он получит предупреждение от компилятора (что он использует устаревший метод).

Однако аннотация @Deprecated не исключает устаревший метод из javadoc.Вот что вам нужно сделать, чтобы исключить метод из javadoc: Когда вы генерируете javadoc, используйте параметр строки nodeprecated javadoc cmd.Опция -nodeprecated предотвращает создание любого устаревшего API в документации.Поэтому, если вы используете аннотацию @Deprecated и генерируете javadoc с опцией -nodeprecated, ваш плохой метод не будет отображаться в javadoc.

Но, по моему мнению, вы не должны исключать устаревшие публичные методы из своего javadoc,Лучше, если они появятся в документации с объяснением того, почему метод устарел и что использовать вместо него.