Question

我们为projet创建了一个自定义Doclet，以便为我们的客户生成特定文档。

我们定义了一些在生成文档时由doclet解析的特定标记。

在我们的javadoc评论中缺少这些特殊标签时，您知道如何让eclipse添加警告吗？

格式良好的javadoc示例：

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

如果缺少@dialogName，开发者应该在eclipse中发出警告......

我看一下checkstyle，但我不明白如何配置它来做这样的事情。

提前感谢您的帮助。

Answer 1

这应该由 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>

有关缺少自定义javadoc标记的警告

1 个答案: