Как я исключаю определенный метод/конструктора из результатов javadoc задачи Ant?
На самом деле довольно легко управлять как отдельный процесс. При перенаправлении StandardOut и StandardError тогда, можно подписаться на Процесс. OnData* события и получают вывод командной строки. Это тогда достаточно тривиально, чтобы проанализировать строку состояния с помощью regex и разработать вещи как %, завершенный и так далее.
самая твердая вещь удается что командную строку передать для получения достойного качества! Я рекомендовал бы эта страница и эта страница , если Вы используете H.264/AAC +.
5 ответов
См. Соответствующую статью Javadoc FAQ .
В настоящее время нет опции Javadoc скрыть, исключить или подавить общественное члены из созданной javadoc документация.
Похоже, это невозможно в vanilla Javadoc, но предлагаются некоторые обходные пути.
Это невозможно сделать для общедоступных методов. Стандартная практика (даже во многих классах JDK) заключается в том, чтобы указать, что метод или конструктор не предназначен для публичного использования.
Есть план добавить тег @exclude в будущем :
@exclude - для исключения API из поколение Javadoc. Программист отметит класс, интерфейс, конструктор, метод или поле с @exclude. Наличие тега вызовет API исключить из сгенерированного документация. Текст после тега может объяснить причину исключения, но будет проигнорирован Javadoc. (Ранее предлагалось как @hide, но термин "скрыть" больше подходит для динамическое отображение / скрытие во время выполнения возможность.) Для получения дополнительной информации см .: Запрос функции № 4058216 в Developer Соединение.
Измените уровень доступа метода, затем используйте атрибуты фильтрации уровня доступа javadoc задачи, частный , пакет и т. Д. Делайте это только в том случае, если это имеет смысл в вашем коде, хотя, например, метод, который имел ненадлежащим образом свободные уровни доступа.
Для конструкторов, например, вы можете уменьшить уровень доступа до package , затем создайте фабричный класс в том же пакете, который обеспечивает доступ к построению вне пакета. Класс фабрики можно легко отфильтровать из документации javadoc. Вроде хакерский, но работает.
Разве исключение чего-то общедоступного из вашей документации не является просто вариацией на тему «безопасность через неясность» (или, скорее, «документация через неясность»)? Если конструктор является частью API вашего кода, он доступен для использования. Если они узнают об этом и используют его, то в этом ли их вина (раз уж вы сделали это в первую очередь)?
Если вы можете изменить видимость конструктора или вообще удалить его, я бы пошел на это. Если вы не можете удалить его из API, сообщите в документации Javadoc для конструктора, что он не предназначен для использования через веб-службу. Таким образом, вы заключили договор с пользователями вашего API, информируя их о том, чтобы они не использовали его.
Лучше задокументировать, что его не следует использовать, вместо того, чтобы не документировать его вообще (если он общедоступный).
Попробуйте ExcludeDoclet Криса Ноклеберга: http://www.sixlegs.com/blog/java/exclude-javadoc-tag.html
Я только что экспериментировал с этим, и, похоже, это помогло.