groovy - 有没有办法将 Javadoc 文档注释附加到 Groovy 脚本？

Question

对于 Groovy 或 Java 类或方法，我通常会在文档注释(也称为 Javadoc 注释)中包含任何 API 级文档，而不是常规注释。添加有关 Groovy 脚本的此类注释的类似方法是什么？

我个人不太关心 Javadoc 工具是否获取文档。然而，有关 Groovy 脚本用途的文档在概念上似乎类似于类的文档注释；因此，我直觉地希望它们出现在文档评论中。如果我的直觉是错误的，并且文档标签不是注释 Groovy 脚本意图的标准方式，那么记录脚本用途的首选方法是什么？

Answer 1

syntax section Groovy 语言规范定义了可以与 Groovydoc 注释关联的元素:

[Groovydoc] comments are associated with:

• type definitions (classes, interfaces, enums, annotations),
• fields and properties definitions
• methods definitions

Although the compiler will not complain about Groovydoc comments not being associated with the above language elements, you should prepend those constructs with the comment right before it.

脚本没有类类型定义来在前面放置 Groovydoc 注释。

Groovy 问题跟踪器中存在一个请求此功能的未解决问题，地址为 GROOVY-8877 :

Groovydoc doesn't offer any direct way to document Groovy scripts. It will process comments on classes in a Groovy script, but not any sort of file-level or top-level comment.

总之，Groovy 脚本文件当前不支持脚本级 Groovydoc 注释。