Sauberer Code: acceptable Parametername für die Funktion

Question

Ich habe einen Controller, 2 von String 1 und String zwei Endpunkt erhalten aussetzt:

Controller:

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

Hinter den Kulissen, meine Schnittstelle und impl Klasse Verwendung die gleiche Funktion:

String details(String **attr**) 

Was kann ich benennen Sie die attr zu so t Hat es sauber und lesbar?

Answer 1

Ich schlage vor, Sie einen Namen und javadoc wählen, was über diesen Parameter kommen in könnten:

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