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

Is there a way to attach a Javadoc doc comment to a Groovy script?

对于 Groovy 或 Java class 或方法,我通常会在文档注释中包含任何 API 级别的文档(又名 Java文档评论),而不是常规评论。添加关于 Groovy 脚本的此类评论的类似方法是什么?

我个人不太关心 Javadoc 工具是否提取文档。但是,关于 Groovy 脚本用途的文档在概念上类似于 class 上的文档注释;因此,我直觉上希望它们出现在文档注释中。如果我的直觉是错误的,并且 doc 标签不是注释 Groovy 脚本意图的标准方式,那么 记录脚本目的的首选方法?

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

[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.

脚本没有 class 类型定义来放置 Groovydoc 注释。

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

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 脚本文件目前不支持脚本级 Groovy 文档注释。