Ce contenu est réservé aux membres du site. Si vous êtes un utilisateur existant, veuillez vous connecter. Les nouveaux utilisateurs peuvent s'inscrire ci-dessous.
Commenter et documenter son code (PHP)
Objectifs Distinguer commentaires (dans le code) et documentation (vue d’ensemble). Savoir écrire des DocBlocks PHPDoc simples et utiles. Adopter des règles claires et homogènes pour l’équipe. 1) Commenter vs documenter Commenter (dans le code) But : expliquer l’intention et les choix (le “pourquoi”), pas réécrire le code. Placer un commentaire juste au-dessus d’un bloc non évident, d’un calcul “piège”, d’un contournement temporaire. Référencer un ticket/bug si besoin (// FIXME: #123). Un commentaire faux → à supprimer : mieux pas de commentaire qu’un commentaire trompeur. À éviter : commenter l’évidence (// ajoute 1 au-dessus de i++) ou écrire des pavés de