清潔代碼：爲功能

Question

接受的參數名我有一個控制器，它暴露了兩個端點的字符串1和字符串2得到：

控制器：

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

在幕後，我的接口和實現類使用相同的功能：

String details(String **attr**) 

可我的ATTR重命名什麼因此T帽子它乾淨可讀？

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){ 
    ... 
}