有没有办法将Javadoc注释附加到Groovy脚本？

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

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

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

[Groovydoc]注释与以下内容关联：

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

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

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

Groovy问题跟踪器中存在一个请求此功能的未决问题，位于：

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

---

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

您想要的是什么？下面是使用@dmahapatro的示例-该链接确实演示了我的要求。然而，它并不完全具有权威性。此外，如果查看示例中某个类与脚本的GroovyDoc输出，您将看到类级文档是在GroovyDoc类示例中输出的，而不是在脚本示例中输出的。这让我相信这实际上可能不是一种“正确”的方法。文章本身指出，Groovydoc输出中没有包含文档：“生成的Groovy脚本文档只记录了脚本中定义的方法”遗憾的是，情况仍然如此。我可以为脚本中的函数生成文档，但顶部没有描述脚本的内容。