如何将 groovy 文件的 java 注释解析为 html 格式?
How to parse the java comments of a groovy file to html format?
我有一组 .groovy 文件 (Java)。所有这些文件都具有相同的注释格式。
我开发了一个工具,可以读取这些文件并应用正则表达式来获取列表中的所有评论。 (最后我只需要将这些评论复制粘贴到 .html 文件)
我想知道生成带有评论(一种文档)的 HTML 页面是否正确。如果没有,你会推荐什么?
我阅读了 Doxygen 和 Javadoc,但我不确定是否使用它们(如果它们对我来说真的有用,因为评论已经写好了)
如果您可以建议一个图书馆以便轻松生成 HTML 网页或任何其他建议。
感谢任何帮助。
存在 Groovydoc which is roughly the equivalent of Javadoc,仅供 Groovy。
由于您的设置不是那样(您已经有评论,可能不是 Groovydoc 格式,并且您有一半的工具),仍然有多种方式可供您使用。由于您已经从 groovy 中提取了文档,如果我是您,我会在必要时进行最小化 post 格式化,并将文档输出为 markdown(例如 github markdown) or asciidoc (e.g., asciidoctor)。然后您可以使用任何首选工具将 post 格式的文档转换为 HTML.
回答问题 "How to parse the java comments" – 你不应该。如果可能,尤其是在新项目中,坚持使用标准工具。在 Groovy 的情况下,这是 Groovydoc。普通的(非 Java/Groovy-Doc 风格)注释本身你永远不需要从源代码中提取。它们应该是特定于上下文的,如果没有相应的代码,它们无论如何都是无用的。
我有一组 .groovy 文件 (Java)。所有这些文件都具有相同的注释格式。 我开发了一个工具,可以读取这些文件并应用正则表达式来获取列表中的所有评论。 (最后我只需要将这些评论复制粘贴到 .html 文件) 我想知道生成带有评论(一种文档)的 HTML 页面是否正确。如果没有,你会推荐什么?
我阅读了 Doxygen 和 Javadoc,但我不确定是否使用它们(如果它们对我来说真的有用,因为评论已经写好了)
如果您可以建议一个图书馆以便轻松生成 HTML 网页或任何其他建议。
感谢任何帮助。
存在 Groovydoc which is roughly the equivalent of Javadoc,仅供 Groovy。
由于您的设置不是那样(您已经有评论,可能不是 Groovydoc 格式,并且您有一半的工具),仍然有多种方式可供您使用。由于您已经从 groovy 中提取了文档,如果我是您,我会在必要时进行最小化 post 格式化,并将文档输出为 markdown(例如 github markdown) or asciidoc (e.g., asciidoctor)。然后您可以使用任何首选工具将 post 格式的文档转换为 HTML.
回答问题 "How to parse the java comments" – 你不应该。如果可能,尤其是在新项目中,坚持使用标准工具。在 Groovy 的情况下,这是 Groovydoc。普通的(非 Java/Groovy-Doc 风格)注释本身你永远不需要从源代码中提取。它们应该是特定于上下文的,如果没有相应的代码,它们无论如何都是无用的。