关于丢失自定义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标签的警告

回答

相关问题