我有一组.groovy文件(Java)。所有这些文件都具有相同的注释格式。 我开发了一个工具,我能够读取这些文件并应用REGEX来获取列表中的所有注释。 (最后我只需将这些评论粘贴到.html文件中) 我想知道是否正确的做法是为了生成带有评论的HTML页面(一种文档)。如果没有,你会推荐什么?
我读到了Doxygen和Javadoc,但我不确定是否使用它们(如果它们在我的情况下非常有用,因为评论已经写好了)
如果您可以推荐图书馆,以便轻松生成HTML网页或任何其他建议。
感谢任何帮助。
答案 0 :(得分:3)
存在Groovydoc大致相当于Javadoc,仅适用于Groovy。
由于您的设置不是那样(您已经有了注释,可能不是Groovydoc格式,并且您有一半的工具),仍然有多种方式可供您使用。正如你已经从groovy中提取文档一样,如果我是你,我会在必要时进行最小的格式化,并将文档输出为markdown(例如github markdown)或asciidoc(例如{{3} })。然后,您可以使用任何首选工具将格式化后的文档转换为HTML。
要回答“如何解析Java评论”的问题 - 你不应该这样做。如果可能的话,特别是在新项目中,坚持使用标准工具。在Groovy的情况下,这是Groovydoc。正常(非Java / Groovy-Doc样式)注释您自己永远不需要从源代码中提取。它们应该是特定于上下文的,如果没有相应的代码,它们无论如何都是无用的。