如何在Groovy/Grails中记录标记库(或一般的闭包)

如何在Groovy/Grails中记录标记库(或一般的闭包),grails,documentation,groovy,Grails,Documentation,Groovy,我正在编写我的第一个taglib作为插件的一部分,我想记录它。添加javadoc(是否有任何地方可以记录groovydoc或者它真的是一样的东西?)似乎对非方法不起作用 具体而言,如何在以下文件中记录def mytag: /** * This doc shows up */ class MyTagLib { static namespace = "myns" /** * This doc does not show up, but I'd like to document a

我正在编写我的第一个taglib作为插件的一部分,我想记录它。添加javadoc(是否有任何地方可以记录groovydoc或者它真的是一样的东西?)似乎对非方法不起作用

具体而言,如何在以下文件中记录def mytag:

/**
 * This doc shows up
 */
class MyTagLib {
  static namespace = "myns"

  /**
   * This doc does not show up, but I'd like to document attrs.
   */
  def mytag = {attrs ->
    out << "something"
  }
}
/**
*这个医生出现了
*/
类MyTagLib{
静态名称空间=“myns”
/**
*此文档未显示,但我想记录属性。
*/
def mytag={attrs->

你的问题让我很好奇,我环顾了一下四周。似乎没有什么好办法

我认为目前最好的方法是在类级javadoc头中记录可用的标记和它们的参数。至少这样,它们会出现在最终的API规范中,供人们查看

我注意到有一些关于groovydoc的讨论,但我似乎找不到任何完全官方的东西,特别是在Grails的使用方面嗯

<property environment="env"/>
<target name="groovydoc">
  <taskdef name="groovydoc" classname="org.codehaus.groovy.ant.Groovydoc">
    <classpath>
      <path path="${env.GRAILS_HOME}/lib/groovy-all-1.5.6.jar"/>
    </classpath>
  </taskdef>
  <mkdir dir="docs/gapi"/>
  <groovydoc destdir="docs/gapi" sourcepath="grails-app" use="true" windowtitle="groovydoc" private="true"/>
</target>


如果处理groovydoc的时间足够长的话,您可以通过按摩groovydoc让它与taglibs一起工作,或者如果您有时间尝试的话,它也可以与Grails 1.1 beta一起工作。

我刚刚读到了关于新的Groovy 1.6 RC的文章,这让我想到了Jira,它有一些关于groovydoc的开放bug,包括一个专门关于文档的bug,which仍然是开放的。最新的评论提到了trunk中的部分实现,所以我必须检查一下

这就清除了当前的状态。与此同时,我强迫自己将我的taglib释放到野外,并记录它,这是我使用常规HTML页面(wiki生成的).对此我有话要说,因为如果在大量自动生成的dreck中发现唯一包含taglib详细信息的文档,我实际上会被推迟