我创建了一个像这样的方法:
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
参数具有默认值?(即,是否可以设置某些元数据,或者只是在英语说明中向读者明确显示了这些元数据?) 最佳答案
但是,如何记录命名参数?
除非您正在考虑编写客户doclet或类似文档,否则我认为您只是将它们记录为注释中的文本。