【问题标题】:are there any tools that check the quality of javaDoc (phpDoc, etc.) automatically?是否有任何工具可以自动检查 javaDoc(phpDoc 等)的质量?
【发布时间】:2011-02-05 03:07:34
【问题描述】:

您知道任何可以运行代码并在 javaDoc 块中查找缺陷的工具吗? (也可以解析其他语言,如 PHP、C# 等)。

【问题讨论】:

    标签: javadoc phpdoc


    【解决方案1】:

    Doxygen 报告文档中的错误。根据其配置方式,它还可以在缺少文档时进行报告。

    一个类似的问题(但不完全相同):Is there a way to validate the presence of Javadoc and/or inline code comments?

    【讨论】:

      【解决方案2】:

      对于 phpDoc,PHPDocumentor 会给你一个错误列表。

      【讨论】:

      • 您能否解释一下我如何才能获得 phpDoc 的错误列表?我在他们的文档中找不到这个。谢谢!
      • 我相信它实际上会生成一个 errors.html 文件。此外,当我运行它时,它会为我吐出大量警告。默认情况下,它也会在控制台中显示它们,除非使用 -quiet。
      【解决方案3】:

      我最近启动了一个开源 JavaDoc 检查实用程序:OpenJavaDocCheck。该项目还很年轻,但有一些特点:

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

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2022-01-16
        • 2019-04-01
        • 1970-01-01
        • 2015-04-11
        • 2016-04-25
        • 2010-12-19
        • 2015-07-01
        • 2011-01-25
        相关资源
        最近更新 更多