【问题标题】:What are the 3 types of JavaDocs for Groovy 1.8?Groovy 1.8 的 3 种 JavaDocs 是什么?
【发布时间】:2011-06-29 18:40:42
【问题描述】:

Groovy 1.8 文档有 3 种类型的 JavaDoc:

API/ 盖比/ jdk/

jdk/Javadocs 展示了 Groovy 添加到 Java 类的方法。这很容易理解。

api/ 和 gapi/ 中的 JavaDocs 令人困惑。它们是相似的,只是 api/ 具有所有类的不区分大小写显示,而 gapi/ 具有所有类的区分大小写显示。 (区分大小写的显示让人很难找到东西。)

gapi/ All Classes 列表的末尾有四个 genXXX 条目(再次区分大小写排序),它们似乎不在 api/ 列表中。

有谁知道 api/ 和 gapi/ JavaDocs 之间有什么区别?

谢谢。

【问题讨论】:

    标签: groovy groovydoc


    【解决方案1】:

    引自Paul King on the Groovy User邮件列表

    “api”是运行javadoc的结果 跨所有 Java 文件。

    “gapi”是运行的结果 groovydoc 跨所有 Java 和 Groovy 文件。 (历史上这是 只是 Groovy 文件,但它现在运行 跨越两者。如果 Groovydoc 完成了 我们可以完全删除“api”但是 至少到目前为止,javadoc 有更多 信息,所以我们保留两者。)

    "groovy-jdk" 只在 “类别”文件,如 DefaultGroovyMethods 而不是 报告整个 Javadoc 源文件报告它们 类别扩展的类。 例如:

    DGM#join(收集自我,字符串 分隔符)

    将报告为:

    java.util.Collection#join(字符串 分隔符)

    这就是它的外观 语言用户。

    【讨论】:

    • 呃。我们需要一套全面的文档。 GroovyDoc gapi 应该是最好的,但区分大小写的显示是个问题。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多