Предупреждение о пропущенных пользовательских тегах Javadoc - PullRequest
Новая
       13

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

1 голос
/ 10 мая 2010

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

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

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

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

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

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

Я немного выгляжу в стиле checkstyle, но не понимаю, как настроить его для такой вещи.

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

1 Ответ

0 голосов
/ 10 мая 2010

Это должно быть обнаружено инструментом 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>
...