maven-2 - 如何让 mvn checkstyle 检查我的所有 javadoc 注释内容是否都以大写字母开头？

Question

我想配置我的 checkstyle，以便它验证我所有以大写字母开头的 javadoc 注释:

/** 
 * Hello

我可以在哪里进行设置？我想我必须首先在评论上启用 checkstyle，但我不知道如何启用。

然后如何设置一个过滤器来检查 \/\*\* 的出现，然后确保 \s*\*\s[A-Z]+ 如下？

编辑:如果 checkstyle 目前不支持我所需要的:How do I set up my own checkstyle modul and include it?

Answer 1

目前，Checkstyle 不支持您想要获得的内容(据我所知)。但执行此操作的过程应该如下:

• 将 checkstyle maven 插件 org.apache.maven.plugins:maven-checkstyle-plugin 添加到您的 Maven2 POM。
• 创建一个包含您想要的规则的 checkstyle 配置。
• 在 POM 中将该配置引用为 configLocation。

Checkstyle 支持作为类和样式的规则:

• 检查空 JavaDoc
• 检查第一句话(它是否存在)
• 检查句子结尾(但不检查开头)

你能做的(从长远来看)是扩展checkstyle，并为社区提供你的增强，因此它可能会集成到Checkstyle本身和Checkstyle的Maven插件中。看看"Extending Checkstyle" ，其实没那么难，我自己就做到了。请参阅 Checkstyle JavaDoc Style 的实现示例。困难的部分是将其放入项目中，并在您需要的任何地方获取它:Maven、Eclipse、NetBeans、Sonar，...