Est-ce une bonne pratique d'écrire des commentaires pour des méthodes largement connues comme equals, compareTo, etc.?
Considérez le code ci-dessous.
/**
* This method compares the equality of the current object
with the object of same type
*/
@Override
public boolean equals(Object obj) {
//code for equals
}
Mon entreprise souhaite entrer des commentaires comme ci-dessus. Le commentaire Javadoc ci-dessus est-il requis? N'est-il pas évident et bien compris ce que fait la méthode des égaux et les goûts (comparer, comparer à), etc.?
Quelles sont vos suggestions?