【问题标题】:How to parse the java comments of a groovy file to html format?如何将 groovy 文件的 java 注释解析为 html 格式?
【发布时间】:2018-05-17 19:01:31
【问题描述】:

我有一组 .groovy 文件 (Java)。所有这些文件都具有相同的注释格式。 我开发了一个工具,我可以读取这些文件并应用正则表达式来获取列表中的所有 cmets。 (最后我只需将这些 cmets 复制粘贴到 .html 文件中) 我想知道生成带有注释的 HTML 页面(一种文档)是否是正确的做法。如果没有,你会推荐什么?

我阅读了有关 Doxygen 和 Javadoc 的信息,但我不确定是否要使用它们(如果它们对我来说真的有用,因为 cmets 已经编写好了)

如果您可以建议一个库以便轻松生成 HTML 网页或任何其他建议。

感谢任何帮助。

【问题讨论】:

    标签: regex groovy javadoc doxygen


    【解决方案1】:

    存在Groovydoc,大致相当于Javadoc,仅适用于Groovy。

    由于您的设置并非如此(您已经有 cmets,可能不是 Groovydoc 格式,并且您拥有一半的工具),因此仍有多种方法可供您使用。由于您已经从 groovy 中提取了文档,如果我是您,我会在必要时进行最少的后期格式化,并将文档输出为 markdown(例如,github markdown)或 asciidoc(例如,asciidoctor)。然后,您可以使用任何首选工具将后格式化文档转换为 HTML。

    要回答“如何解析 java cmets”这个问题——你不应该。如果可能,尤其是在新项目中,请坚持使用标准工具。对于 Groovy,那就是 Groovydoc。普通的(非 Java/Groovy-Doc 风格的)cmets 本身是你永远不需要从源代码中提取的。它们应该是特定于上下文的,如果没有相应的代码,它们无论如何都是无用的。

    【讨论】:

    • :+1: 也可以使用groovydoc机制来test all the examples in your documentation :-)
    • 感谢您的帮助,我刚刚下载了 Groovydoc 并打开了文档。但是我面临着麻烦。我的 groovy 文件很简单 /*--- TITLE ---/ /- Method 1 -*/ Some code... until method n 但是生成的html是空的,命令行似乎是正确的
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2019-07-15
    • 1970-01-01
    • 2011-03-18
    • 2010-10-17
    相关资源
    最近更新 更多