Groovydoc : Documenting named parameters

Question

我创建了一个这样的方法:

void myMethod(Map kwArgs, def myParam)
{
   println kwArgs.firstName
   println [kwArgs.lastName, "Wilcox"].find()  
   // ^^^ if lastName named parameter not specified, "Wilcox"

   ....
}

现在是时候用 GroovyDoc 来记录这个方法了。部分很容易

/**
  myMethod rules the world
  @param myParam something something

但是我如何记录命名参数？ (同样，我如何指定 lastName 参数具有默认值？(即是否有一些我可以设置的元数据或只是在英文描述中向读者明确说明？)

Answer 1

But how do I document the named parameters?

除非您正在考虑编写客户 doclet 或类似文档，否则我认为您只需将它们记录为评论中的文本即可。