Мы создаем пользовательский Doclet для нашего проекта, чтобы создать конкретную документацию для нашего клиента.Предупреждение о пропущенных пользовательских тегах javadoc
Мы определяем некоторые теги, которые обрабатываются документацией, когда мы создаем документацию.
Вы знаете, как спросить затмение, чтобы добавить предупреждение, когда те специальные теги отсутствуют в наших комментариях javadoc?
Пример хорошо образованного Javadoc:
/**
* @dialogName TECK-01-E-608
* @useVO ServiceVO
* @useVO AgentVO
*/
public class MyDialog extends BaseDialogImpl {
...
Если @dialogName отсутствует, developper должен иметь предупреждение в затмении ...
Я смотрю Checkstyle немного, но я не понять, как его настроить, чтобы делать такую вещь.
Заранее за вашу помощь.
Благодарим за ваш ответ, я попытаюсь это. Но это похоже на «игнорировать» вместо «ничего». Можно ли ограничить эту проверку только подмножеством классов? Я хочу, чтобы только те классы, которые были получены из BaseDialogImpl, имеют этот тег. – flumins
@flumins: спасибо за комментарий, я исправил ответ. Я не уверен, что вы можете применить его к определенной иерархии классов, даже если вы можете запустить checkstyle на подмножестве своего проекта (но это не касается вашей точки). – VonC