Ajouter des commentaires en PHP : 7 étapes (avec images)

Teneur

Pas
- Partie 1 sur 2: Styles
- Partie 2 sur 2: Utiliser
Des astuces

Les commentaires dans un langage de programmation sont certaines notes qui peuvent être utilisées pour clarifier le but et l`intention d`un bloc de code. Lorsque vous utilisez PHP, vous avez le choix entre plusieurs options qui proviennent de langages de programmation largement utilisés et plus anciens avec deux choix en ce qui concerne les commentaires sur une seule ligne et également un formulaire de commentaire multiligne, dérivé du style utilisé dans le C. langage de programmation. Vous pouvez utiliser des commentaires pour empêcher l`exécution de blocs de code, et vous pouvez même les utiliser pour générer de la documentation.

Pas

Partie 1 sur 2: Styles

1. Utilisez un commentaire d`une ligne pour les commentaires courts. Si vous souhaitez publier un court commentaire, vous pouvez utiliser le code d`une ligne pour cela. Ce commentaire ne dépasse pas la fin de la ligne ou la fin du bloc de code. Ce type de commentaire ne fonctionne que dans les balises PHP et sera lu s`il est placé dans du code HTML.

1. Utilisez des commentaires multilignes pour des commentaires plus approfondis ou des tests de code. Les commentaires sur plusieurs lignes sont utiles pour rédiger une explication plus longue ou pour empêcher l`exécution d`un certain segment de code. Lire la partie "Usage" ci-dessous pour quelques conseils sur l`utilisation des commentaires multilignes.

Partie 2 sur 2: Utiliser

1. Utilisez des commentaires pour laisser des commentaires sur le fonctionnement du code. Il n`est pas nécessaire de le faire pour chaque ligne de code, car le code bien écrit est facile à comprendre pour les autres programmeurs. C`est utile s`il y a des fonctions inhabituelles ou peu claires dans le code.

// Génère une requête curl $session = curl_init($request); // Dites à curl d`utiliser HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Laissez un commentaire pour ne pas oublier ce que vous avez fait. Lorsque vous travaillez sur vos propres projets, les commentaires peuvent vous aider à vous rappeler où vous vous êtes arrêté. Commentez le code qui ne fonctionne pas ou que vous n`avez pas encore terminé.

// Je dois regarder ça avant de continuer echo "Bonjour le monde!";

Commentez le code que vous souhaitez partager. Si vous envisagez de collaborer avec d`autres, ou si vous souhaitez rendre le code open source, les commentaires peuvent aider les autres à découvrir ce que font vos fonctionnalités et où elles peuvent s`améliorer.

/* Existe-t-il un moyen plus efficace de le faire? */ Sexe :

Utilisez des commentaires pour empêcher l`exécution de certains blocs de code. Ceci est utile si vous souhaitez tester quelque chose et empêcher l`exécution de certains codes. Tout ce qui se trouve dans les balises de commentaire sera ignoré lors du chargement de la page Web.

2. Soyez prudent lorsque vous commentez de gros blocs de code. La fonction de commentaire s`arrêtera lorsque la première balise de fin est signalée, donc s`il y a déjà un commentaire multiligne dans le code que vous souhaitez commenter, ce commentaire s`arrêtera à la fin du commentaire imbriqué.

3. Utilisez des commentaires pour créer une pseudo-documentation. Vous pouvez utiliser un formatage créatif pour créer une documentation pour votre code directement dans le code. Cela peut être utile pour les projets open source.

Des astuces

Les commentaires HTML et les commentaires PHP sont différents les uns des autres, donc si vous utilisez des scripts (un mélange de HTML et PHP), veillez à ne pas confondre les codes de commentaires.
Par exemple, dans le code ci-dessous, il y a des commentaires HTML, mais le code PHP est toujours exécuté. Placer des commentaires HTML dans les balises PHP provoquera des erreurs.