Groovydoc：记录命名参数

发布时间：2020-12-14 16:21:44 所属栏目：大数据来源：网络整理

导读：我创建了一个这样的方法： void myMethod(Map kwArgs,def myParam){ println kwArgs.firstName println [kwArgs.lastName,"Wilcox"].find() // ^^^ if lastName named parameter not specified,"Wilcox" ....} 现在是时候用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或类似内容,否则我认为您只需将其作为文本记录在评论中.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!