Code propre: nom du paramètre acceptable pour la fonction

Question

je un contrôleur qui expose deux endpoint obtenir par chaîne 1 et la chaîne 2:

contrôleur

:

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

Dans les coulisses, mon interface et impl utilisation de classe la même fonction:

String details(String **attr**) 

Que puis-je renommer le attr à tant t Est-ce que c'est propre et lisible?

Answer 1

Je vous suggère de choisir un nom et javadoc ce qui pourrait venir via ce paramètre:

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