【发布时间】:2019-08-01 11:31:13
【问题描述】:
我想写一个 Maven 插件,它遍历所有源代码并提取带有特殊注释的类,并将它们写入 HTML 文件。
这可能吗?如果是,有什么推荐的方法吗?
【问题讨论】:
-
您能否提及您希望从源代码中提取的内容?是不是类似于JavaDoc的创建?
-
JavaDoc 不是更好的候选者,因为 Maven 已经可以生成 JavaDoc。是类的注释部分,比如
@Entity,如果仅用于文档目的,我会考虑扩展 JavaDoc。 -
是的,非常相似。它应该监视特定的注释并创建一个带有注释的类的目录。 @KavithaKarunakaran
-
@MauriceNino - 我认为您可以为此重用 maven-resources-plugin。
-
理论上我相信你可以扩展 JavaDoc,所以这将是我最初会考虑的路线,因为它旨在记录事物并且 maven 已经有一个插件。至于 Swagger,它也可以用来为 Java 生成文档,当我使用它时,你可以生成非常复杂的文档,虽然我认为这涉及到很多 YAML,但我认为你也对类进行了注释。