Groovydoc：记录命名参数

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

但如何记录命名参数呢？

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