有没有自动检查javaDoc(phpDoc等)质量的工具?
您知道有什么工具可以运行代码并发现 javaDoc 块中的缺陷吗? (也可以解析其他语言,例如 PHP、C# 等)。
Do you know any tools that can run through the code and find defects in javaDoc blocks? (would be nice to parse other languages also, like PHP, C#, etc).
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
对于 phpDoc,PHPDocumentor 将为您提供错误列表。
PHPDocumentor will give you a list of errors, in the case of phpDoc.
Doxygen 报告文档中的错误。根据其配置方式,它还可以报告文档丢失的情况。
类似的问题(但不完全相同): 有没有办法验证 Javadoc 和/或内联代码注释是否存在?
Doxygen reports errors in the documentation. Depending on how it is configured it can also report when documentation is missing.
A similar question (but not exactly the same): Is there a way to validate the presence of Javadoc and/or inline code comments?
我最近启动了一个开源 JavaDoc 检查实用程序:OpenJavaDocCheck。该项目相当年轻,但有一些功能:
I recently started a open source JavaDoc checking utility: OpenJavaDocCheck. The project is fairly young, but some features are: