Des commentaires, pourquoi ?

Avoir des commentaires peut donner une impression de lourdeur à la lecture du code. Si celui-ci est bien utilisé, il devient même un atout pour tout développeur.

Ils ne doivent jamais être écrit à la fin. J’irai même jusqu’à dire qu’ils doivent être parmi les premiers éléments à être affichés. Il est important d’écrire ce que l’on souhaite faire pour organiser son code, cela peut se faire sur papier et pourquoi pas grâce à des commentaires.

Tu n’es pas infaillible, ce que tu as écris maintenant ne te sera peut-être plus aussi clair dans 6 mois.

Enfin, même si ton code te parait lisible et compréhensible, ce ne sera pas forcément le cas d’un autre codeur, une petite phrase pour expliquer, pour couper ou organiser sera toujours la bienvenue.

Comment insérer des commentaires

Maintenant qu’on a vu pourquoi, passons au comment. Il existe deux type de commentaire :

• sur une ligne
• sur plusieurs lignes

Pour un commentaire sur une ligne, y compris après du code :

// Voici un commentaire sur une ligne
$var = 12
// Je rajoute 3 à $var
$var = 12 + 5 // pourquoi ai-je ajouter 5

Pour le commentaire sur plusieurs lignes :

function mettreDuCommentaire()
{
    /*
    Cette fonction a pour but
    de montrer l'utilisation
    des commentaires sur 
    plusieurs lignes
    */
}

Conclusion

Alors n’hésites pas à utiliser les commentaires, ils peuvent être utiles à toi ou n’importe qui qui reviendrait sur ton code.

L’article PHP, les commentaires est apparu en premier sur La programmation sur le web.