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

Question

我正在编写我的第一个 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"
  }
}

由于 Grails 中的很多东西都是使用闭包指定的，如果真的不可能记录它们，那么看起来我们有问题。是否有其他一些涉及我应该使用的单独文档文件的解决方案？

Answer 1

我刚刚阅读了关于新的 Groovy 1.6 RC 的信息，这让我想到了 Jira，它有几个关于 groovydoc 的 Unresolved 错误，其中一个专门关于记录 fields and properties ，它仍然是开放的。最新评论提到了主干中的部分实现，所以我必须检查一下。

这样就清除了当前状态。与此同时，我强制自己将我的 taglib 发布到野外并记录它，我使用常规 HTML 页面(维基生成)完成了这项工作。对此有一些话要说，因为如果发现包含有关 taglib 的详细信息的唯一文档被埋在许多自动生成的垃圾桶中，我实际上会被推迟。