Commentaires

Le code est écrit et maintenu par des humains. Assurez-vous que votre code est auto-portant, bien commenté et compréhensible par d'autres.

Les bons commentaires apportent du contexte et de l'information.

Ne répétez pas simplement le nom du composant ou de la classe.

Assurez-vous d'écrire des phrases complètes pour les longs commentaires et des phrases simples pour les notes d'ordre général.

/* Bad */
/* Modal Header */
.modal-header {
  ...
}

/* Good  */
/* Encadrement pour .modal-title et .modal-close */
.modal-header {
  ...
}