对于Groovy或Java类或方法，我通常会在doc注释（也称为Javadoc注释）中包含任何API级文档，而不是常规注释。添加有关Groovy脚本的注释的类似方法是什么？
我个人并不在乎Javadoc工具是否会收集文档。但是，有关Groovy脚本用途的文档在概念上类似于对类的doc注释;因此，我会直观地期望他们在文档评论中。如果我的直觉是错误的并且doc标签不是评论Groovy脚本意图的标准方式，那么是是记录脚本用途的首选方法吗？
答案 0 :(得分：1)
根据Groovy语言规范的syntax section，
[GroovyDoc]评论与：
相关联
- 类型定义（类，接口，枚举，注释），
- 字段和属性定义
- 方法定义
虽然编译器不会抱怨GroovyDoc注释与上述语言元素没有关联，但是你应该在它之前加上注释的前缀。
脚本没有类型定义来放置之前的GroovyDoc注释。
在对该问题的评论中，dmahapatro链接到the JavaWorld article，表明它们可以放在脚本文件的顶部。但是，这些注释不包含在GroovyDoc输出中，因此看起来这可能不是正确的机制。
由于这些原因，我必须得出结论，Groovy脚本文件中没有正式支持脚本级GroovyDoc注释。