關於丟失自定義javadoc標籤的警告

我們爲我們的項目創建自定義Doclet，以便爲我們的客戶生成特定的文檔。關於丟失自定義javadoc標籤的警告

我們在生成文檔時定義了一些由doclet解析的特定標籤。

當我們的javadoc註釋中缺少特殊標記時，您是否知道如何提問eclipse來添加警告？形成良好的javadoc的

例子：

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

如果@dialogName丟失，developper應該有日食警告...

我看CHECKSTYLE一點點，但我不瞭解如何配置它來做這樣的事情。

在此先感謝您的幫助。

來源

2010-05-10 flumins

應該由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>

來源

2010-05-10 15:57:12 VonC

感謝您的回答，我會盡力的。但它似乎是「忽略」而不是「沒有」。是否可以將此檢查限制爲只有一個類的子集？我希望只有派生自BaseDialogImpl的類具有此標記。 – flumins 2010-05-11 07:12:34

@flumins：謝謝你的評論，我已經修復了答案。我不確定你可以將它應用於特定的類層次結構，即使你可以在你的項目的一個子集上運行checkstyle（但這不能解決你的觀點）。 – VonC 2010-05-11 07:37:16

關於丟失自定義javadoc標籤的警告

回答

相關問題