La clé pour rédiger des commentaires PHP est de clarifier l'objectif et les spécifications. Les commentaires devraient expliquer "pourquoi" plut?t que "ce qui a été fait", en évitant la redondance ou trop de simplicité. 1. Utilisez un format unifié, tel que DocBlock (/ * /) pour les descriptions de classe et de méthode afin d'améliorer la lisibilité et la compatibilité des outils; 2. Soulignez les raisons de la logique, telles que pourquoi les sauts JS doivent être sortis manuellement; 3. Ajoutez une description d'une vue d'ensemble avant le code complexe, décrivez le processus dans les étapes et aidez à comprendre l'idée globale; 4. Utilisez TODO et FIXME pour marquer raisonnablement des éléments et des problèmes de tache pour un suivi et une collaboration de suivi plus faciles. De bonnes annotations peuvent réduire les co?ts de communication et améliorer l'efficacité de la maintenance du code.

La rédaction de commentaires PHP est en fait un travail technique, et ce n'est pas seulement quelques lignes à expliquer. Les bonnes annotations peuvent vous aider, vous et les autres, à comprendre la logique du code plus rapidement, à réduire les co?ts de communication et à faciliter la maintenance ultérieure. Mais beaucoup de gens écrivent des commentaires trop simples ou trop longs, ce qui peut avoir un effet contre-productif.

Voici quelques conseils pratiques pour que vos commentaires PHP fonctionnent vraiment.

Unify Style avec un format clair

Il existe deux fa?ons courantes d'écrire des commentaires PHP: // pour une seule ligne, /* */ ou /** */ pour plusieurs lignes. S'il s'agit d'un bloc de documents (tel que la classe et la description de la méthode), il est recommandé d'utiliser le format /** */ DocBlock, qui peut générer des documents avec IDE et outils.

Par exemple:

 / **
 * Traiter la demande de connexion de l'utilisateur *
 * @param string $ nom d'utilisateur nom d'utilisateur * @param string $ mot de passe mot de passe * @return bool ligin est réussi * /
Connexion de la fonction ($ nom d'utilisateur, $ mot de passe) {
    // ...
}

Garder un format cohérent non seulement semble bon, mais rend également le travail d'équipe plus fluide.

Les commentaires devraient expliquer "pourquoi", pas seulement "Qu'est-ce qui a fait"

Les commentaires de beaucoup de gens répètent simplement le code et font quelque chose, comme:

 $ i; // augmenter la valeur de i

Ce genre de commentaire n'a aucun sens. Ce que vous devez expliquer, c'est pourquoi ce code est fait. Par exemple:

 // Parce que certains navigateurs ne prennent pas en charge les têtes de saut, vous devez sortir manuellement JS Jump Echo "<Script> window.location.href = &#39;$ url&#39; </cript>";

Les gens qui voient cette fa?on conna?tront la raison de cette logique, plut?t que de simplement voir l'action de surface.

Ajouter une description de résumé avant la logique complexe

Si un certain morceau de code est logiquement emmêlé, comme un jugement complexe ou une nidification de boucle, vous pouvez ajouter un petit paragraphe devant pour expliquer l'idée globale. Par exemple:

 / *
 * Vérifiez le processus des autorisations des utilisateurs:
 * 1. Obtenez d'abord le r?le utilisateur de la session * 2. Associez ensuite le tableau d'autorisation en fonction de la page actuelle * 3. S'il n'y a pas d'autorisation, sautez à la page d'accueil * /

De tels commentaires sont comme des cartes, aidant les gens à comprendre rapidement la direction générale de votre code.

N'ignorez pas le r?le de Todo et FixMe

Pendant le processus de développement, vous pouvez utiliser // TODO: pour représenter des éléments à taper et utiliser // FIXME: pour marquer les problèmes connus. De nombreux éditeurs prennent en charge l'identification de ces balises pour votre recherche ultérieure.

Par exemple:

 // TODO: la fonction de journalisation doit être ajoutée // FIXME: La logique actuelle rapportera une erreur dans des situations spécifiques

Ces informations sont particulièrement utiles pour le travail d'équipe et permet aux autres de savoir que l'endroit est toujours dans un état "semi-finis".

Fondamentalement, c'est tout. Les notes semblent petites, mais si vous avez vraiment besoin de bien le faire, vous devez être patient et expérience. La clé est de penser du point de vue des autres, de ce qu'ils veulent le plus savoir lorsque vous regardez votre code, puis d'ajouter cette partie des instructions.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!