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

对于Groovy或Java类或方法，我通常会在doc评论（又名Javadoc评论）中包含任何API级文档，而不是常规评论。添加有关Groovy脚本的评论的类似方式是什么？有没有办法将Javadoc doc注释附加到Groovy脚本？

我个人并不在意Javadoc工具是否提取文档。但是，关于Groovy脚本的目的的文档在概念上类似于对类的文档评论;因此，我会直觉地期望他们在文档评论中。如果我的直觉是错误的，并且doc标签不是评论Groovy脚本意图的标准方式，那么是是记录脚本用途的首选方法？

来源

2015-11-05 M. Justin

[Groovydoc]（http://docs.groovy-lang.org/latest/html/documentation/#_groovydoc_the_groovy_java_documentation_generator）是什么？这里是使用[脚本中的groovydoc]的示例（http://www.javaworld.com/article/2074120/core-java/documenting-groovy-with-groovydoc.html）。 – dmahapatro

@dmahapatro - 该链接确实展示了我所问的内容。但是，这不完全是权威性的。此外，如果您查看类的GroovyDoc输出与示例中的脚本，则会看到类级别的文档是在GroovyDoc类的示例中输出的，而不是在脚本示例中输出。这使我相信这可能并不是实现这一目标的“正确”方式。 –

每Groovy语言规范的syntax section，

[GroovyDoc的]注释相关联：

类型定义（类，接口，枚举，注释），

字段和属性定义

方法定义

尽管编译器不会抱怨GroovyDoc注释与上述语言元素没有关联，但您应该在其之前添加带有注释的构造。

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

在对该问题的评论中，dmahapatro链接到the JavaWorld article，表明它们可以放在脚本文件的顶部。但是，这些注释并未包含在GroovyDoc输出中，因此这可能不是正确的机制。

由于这些原因，我因此必须得出结论：脚本级别的GroovyDoc注释在Groovy脚本文件中没有正式支持。

来源

2015-11-06 21:41:04

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

回答

相关问题