定义所需的哈希值在一个javadoc

Question

比方说，我有一个Java方法是这样的：

void configure(Map<String, String> values) { 
    assert values.containsKey("x"), "Missing parameter x" 
} 

是否可以在指定的JavaDoc评论说，“X”是values所需的价值？

Answer 1

如果你可以改变方法的签名，并假设x是一个强制性的参数，但有迹象显示Map可以包含其他（可选）参数，你可以在签名本身通过

void configure(String xValue, Map<String, String> optionalValues = [:]) { 

}