清洁代码：函数的可接受参数名称

Question

我有一个控制器，它通过字符串1和字符串2公开两个端点：

控制器：

path1 = "/details/fqdn
path2 = "/details/ip"

在幕后，我的界面和impl类使用相同的功能：

String details(String **attr**)

我可以将 attr 重命名为什么，以便它干净且易读？

Answer 1

我建议您通过该参数选择一个名称和javadoc：

/**
 * my new details function
 * @param host    The fully qualified domain name, or ip of the host
 * @return        The details, as a string
*/
private String details(String host){
  ...
}