2010-05-10 3 views
1

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

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

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

Пример хорошо образованного Javadoc:

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

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

Я смотрю Checkstyle немного, но я не понять, как его настроить, чтобы делать такую ​​вещь.

Заранее за вашу помощь.

ответ

0

Это должно быть обнаружено 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> 
+0

Благодарим за ваш ответ, я попытаюсь это. Но это похоже на «игнорировать» вместо «ничего». Можно ли ограничить эту проверку только подмножеством классов? Я хочу, чтобы только те классы, которые были получены из BaseDialogImpl, имеют этот тег. – flumins

+0

@flumins: спасибо за комментарий, я исправил ответ. Я не уверен, что вы можете применить его к определенной иерархии классов, даже если вы можете запустить checkstyle на подмножестве своего проекта (но это не касается вашей точки). – VonC

Смежные вопросы