使用 Checkstyle 访问 Javadoc？答案

【问题标题】：Javadoc access with Checkstyle?使用 Checkstyle 访问 Javadoc？
【发布时间】：2012-03-13 22:00:48
【问题描述】：

Checkstyle API 中是否有访问 javadoc 注释文本的方法？如何？

“我还没有找到我要找的东西”

【问题讨论】：

Checkstyle 项目正在考虑添加对评论验证的支持，请通过groups.google.com/forum/#!topic/checkstyle/VEVFDsZKLzg支持提案

【解决方案1】：

Checkstyle 提供了一个公开 cmets 的 API。方法FileContents.getJavadocBefore 可用于在文件中某个位置之前定位Javadoc。

查看处理 Javadoc 的 Checkstyle 检查的源代码 - 请参阅 here。一个很好的例子是JavadocStyleCheck。

【讨论】：

太棒了。谢谢奥利弗。 nonJavaDoc cmets 怎么样？我愚蠢的公司需要在文件顶部，在类定义和方法之前的特定注释标题块。我在配置文件中使用 Regexp 来验证文件头 cmets。但是，如果在类或方法之前有一个 nonJavaDoc 注释，我可以访问该文本吗？我笨拙的解决方案是获取 CTOR_DEF 或 METHOD_DEF，然后获取行号……然后获取文件内容……找到该行，然后尝试备份到注释标题。请帮助...谢谢。