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

Question

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

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

Answer 1

Groovy 语言规范的语法部分定义了 Groovydoc 注释可以关联的元素：

[Groovydoc] 注释与：

• 类型定义（类、接口、枚举、注释），
• 字段和属性定义
• 方法定义

尽管编译器不会抱怨 Groovydoc 注释没有与上述语言元素相关联，但您应该在这些结构前面加上注释。

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

在GROOVY-8877的 Groovy 问题跟踪器中有一个请求此功能的未解决问题：

Groovydoc 不提供任何直接记录 Groovy 脚本的方法。它将处理 Groovy 脚本中类的注释，但不会处理任何类型的文件级或顶级注释。

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