有没有自动检查javaDoc(phpDoc等)质量的工具?

发布于 2024-08-27 18:44:15 字数 65 浏览 5 评论 0原文

您知道有什么工具可以运行代码并发现 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 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

﹏半生如梦愿梦如真 2024-09-03 18:44:15

对于 phpDoc,PHPDocumentor 将为您提供错误列表。

PHPDocumentor will give you a list of errors, in the case of phpDoc.

向日葵 2024-09-03 18:44:15

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?

oО清风挽发oО 2024-09-03 18:44:15

我最近启动了一个开源 JavaDoc 检查实用程序:OpenJavaDocCheck。该项目相当年轻,但有一些功能:

  • XHTML+RDFa 输出(或只是 XML,以便您可以使用 XSLT 来创建任何内容)
  • 可扩展(用于测试项目特定的 JavaDoc 模式,例如自定义标记)

I recently started a open source JavaDoc checking utility: OpenJavaDocCheck. The project is fairly young, but some features are:

  • XHTML+RDFa output (or just XML, so that you can use XSLT to create whatever)
  • extensible (to test for project specific JavaDoc patterns, such as custom tags)
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文