groovy - 是否有标准方法来记录 groovy 地图属性？

Question

在 Groovy 中是否有标准的方法来记录地图属性？

对于以下功能，配置包含多个可选属性，例如：

• ignore
• dir
• tags

def publish(Map config) {
  config.ignore ?= true
  // ...
}

我查看了使用 JavaDoc 记录地图的标准方法是什么？; 但是，这不适用于动态地图。理想情况下，我正在寻找类似 JSDoc@typedef或@property.

Answer 1

除了为您的方法添加一些 JavaDoc 的选项之外，没有真正的方法来记录这些......

如果这是一个需要文档的公共 API，您可以转到传递实际参数，或者您可以创建一个用于传递这些选项的类，即：

import groovy.transform.ToString
import groovy.transform.Immutable

@ToString
@Immutable
class Options {
    boolean debug = false
    File dir = new File('.')
    List<String> tags = []
}

println new Options()
println new Options(debug: true, dir: new File("/tmp"))
println new Options(tags: ['a', 'b'])

哪个打印

Options(false, ., [])
Options(true, /tmp, [])
Options(false, ., [a, b])