• [^] # Re: La doc est toujours utile

    Posté par . En réponse au journal De tout, de rien, des liens, bla bla bla. Évalué à 3.

    Une règle de base: commenter le pourquoi (WHY?) et pas le quoi (WHAT?).

    Autrement dit: il faut commenter pourquoi le code fait ce qu'il fait plutôt que d'écrire un commentaire qui décrit ce que fait le code étape par étape, mais en moins bien que le code lui même (sans parler que ces commentaires deviennent rapidement obsolètes). Exemple (vécu probablement des centaines ou milliers de de fois):

     // get first name
 String firstName = getFirstName();
 // concatenate with surname to get fullname
 String fullName = getSurname() + " " + firstName;