Contenu
Un commentaire est une sorte de note qui peut être utilisée pour expliquer le but et la signification d'un extrait de code. En travaillant en PHP, vous aurez plusieurs possibilités pour rédiger des commentaires issus des anciens langages de programmation bien connus : en saisissant des commentaires C monolignes ou multilignes. Vous pouvez utiliser des commentaires pour empêcher un morceau de code de fonctionner ou simplement pour conserver des enregistrements.
Pas
Partie 1 sur 2: Styles
1 Commentaires sur une seule ligne pour les messages courts. Si vous devez laisser un court commentaire, utilisez le code de commentaire d'une ligne. Le commentaire ne s'étendra que jusqu'à la fin d'une ligne ou la fin d'un bloc de code. De tels commentaires ne fonctionnent qu'à l'intérieur des balises PHP et ne seront lus que s'ils sont placés en HTML. ? php // C'est la manière standard (C ++) de créer un commentaire sur une seule ligne # Vous pouvez également utiliser ce style Unix pour créer un commentaire sur une seule ligne ?> var13 ->
2 Utilisez des commentaires sur plusieurs lignes pour écrire de longs commentaires ou tester le code. Les commentaires multilignes sont très utiles pour rédiger de longues explications et pour empêcher le traitement d'un segment de code. Lisez la section Utilisation pour obtenir des conseils sur l'utilisation des commentaires multilignes. ?php / * Voici comment formater un commentaire multi-lignes. Tout le texte jusqu'à la fin de la balise sera inclus dans le commentaire * / / * Certaines personnes aiment inclure * au début de chaque ligne * des puces supplémentaires. Cela améliorera la * lisibilité des commentaires volumineux, bien que ce ne soit pas obligatoire. * /?> var13 ->
Partie 2 sur 2: Utilisation
1 Utilisez des commentaires pour laisser des notes sur la santé du code. Vous n'êtes pas obligé de le faire pour chaque ligne de code, car d'autres programmeurs peuvent facilement trouver du code bien écrit. Les commentaires sont utiles lorsque votre code exécute des fonctions non standard ou non évidentes. // Crée une requête curl $ session = curl_init ($ request); // Dites à curl d'utiliser HTTP POST curl_setopt ($ session, CURLOPT_POST, true);
2 Laissez des commentaires pour ne pas oublier ce que vous avez fait avec le code. Lorsque vous travaillez sur un projet, les commentaires vous éviteront d'oublier où vous vous étiez arrêté. Laissez des commentaires pour le code qui ne fonctionne pas correctement ou que vous n'avez pas encore terminé. // Avant de passer à l'étape suivante, revérifiez la sortie de ce programme echo "Hello World!";
3 Laissez un commentaire pour le code que vous prévoyez de partager. Si vous envisagez de collaborer avec d'autres programmeurs ou que vous allez rendre votre code accessible au public, les commentaires aideront les autres à comprendre comment votre code fonctionne et ce qui doit être corrigé. / * Existe-t-il un meilleur moyen d'y parvenir ? * / Gender: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "checked" ; ?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "checked";?> value = "male " > Homme
4 Laissez des commentaires pour annuler des blocs de code spécifiques. Ceci est très utile lorsque vous testez votre code et que vous souhaitez en arrêter l'exécution. Tout ce qui est inclus dans la marque de commentaire sera ignoré au démarrage de la page. ? php echo "/ * Bonjour * / Monde !"; / * Lorsque le code ci-dessus est exécuté, le mot "Bonjour" ne sera pas reflété * /?> Var13 ->
5 Soyez prudent lorsque vous commentez de gros blocs de code. La fonction de commentaire se terminera lorsque la première marque de fin sera active, donc s'il y a un commentaire multiligne dans le code que vous avez déjà commenté, il ne durera que jusqu'au début du commentaire d'origine. ? php / * echo "Bonjour tout le monde !"; / * Ce commentaire va tout gâcher * / * /?> Var13 ->
? php / * echo "Bonjour tout le monde !"; // Ce commentaire ira bien * /?> Var13 ->
6 Utilisez des commentaires pour créer des pseudo-enregistrements. Vous pouvez utiliser certains formats de code créatif pour créer une entrée de code directement à l'intérieur. C'est assez utile pour les projets open source. ? php // ============= // EN-TÊTE // ============== // ------------ - // Sous-titre // ------------- / * Nom de la section * / # Les entrées peuvent être écrites ici # La deuxième partie peut être écrite ici / * * Utilisez ceci pour expliquer * pourquoi auriez-vous besoin de quelques lignes * ou même de quelques points d'explication * /?> var13 ->
Conseils
- Les commentaires HTML et PHP sont différents les uns des autres, donc lorsque vous travaillez avec des scripts (une combinaison de HTML et PHP), assurez-vous d'utiliser la syntaxe correcte.
- Par exemple, le code suivant contient un commentaire HTML, mais il exécute toujours le code PHP. Si vous mettez un commentaire HTML dans une balise PHP, cela entraînera une erreur.
- ! - div id = "exemple">? php echo 'bonjour'; ?> var13 -> / div> ->
