Предупреждение об отсутствии пользовательских тегов javadoc

Мы создаем собственный Doclet для нашего проекта, чтобы создать конкретную документацию для нашего клиента.

Мы определяем некоторые конкретные теги, которые анализируются доклетом при создании документации.

Знаете ли вы, как попросить eclipse добавить предупреждение, когда эти специальные теги отсутствуют в наших комментариях javadoc?

Пример правильно сформированного javadoc:

/**
 * @dialogName TECK-01-E-608
 * @useVO ServiceVO
 * @useVO AgentVO
 */
public class MyDialog extends BaseDialogImpl {
...

Если @dialogName отсутствует, у разработчика должно быть предупреждение в eclipse...

Я смотрю checkstyle немного, но я не понимаю, как его настроить, чтобы делать такое.

Заранее спасибо за помощь.


java eclipse javadoc
person flumins    schedule 10.05.2010    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Это должно быть обнаружено с помощью инструмента CheckStyle "WriteTag". .
(я знаю, что вы смотрели CheckStyle: в этом ответе упоминается возможная конфигурация):

<module name="WriteTag">
   <property name="tag" value="@dialogName"/>
   <property name="severity" value="warning"/> <!-- if not found, warning -->
   <property name="tagSeverity" value="ignore"/> <!-- if found, display nothing -->
</module>
person VonC    schedule 10.05.2010
comment
Спасибо за ваш ответ, я попробую это. Но, похоже, это игнор, а не ничего. Можно ли ограничить эту проверку только подмножеством классов? Я хочу, чтобы только классы, производные от BaseDialogImpl, имели этот тег. - person flumins; 11.05.2010
comment
@flumins: спасибо за комментарий, я исправил ответ. Я не уверен, что вы можете применить его к определенной иерархии классов, даже если вы можете запустить checkstyle для подмножества вашего проекта (но это не касается вашей точки зрения). - person VonC; 11.05.2010