Groovydoc:记录命名参数

前端之家收集整理的这篇文章主要介绍了Groovydoc:记录命名参数前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我创建了一个这样的方法

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参数有一个默认值?(即我可以设置一些元数据,或者只是在英文描述中向读者显示?)

解决方法

But how do I document the named parameters?

除非您正在考虑编写客户doclet或类似内容,否则我认为您只需将其作为文本记录在评论中.

猜你在找的Groovy相关文章