クリーンコード：機能

Question

のための許容可能なパラメータ名I持つ二つのエンドポイントは、文字列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){ 
    ... 
}