Comment ajouter des commentaires à votre programme PHP


Chaque programmeur a son opinion sur les informations à inclure dans le code du programme. La plupart des programmeurs ajoutent des commentaires avec leur code afin de se rappeler, ainsi qu'à quiconque, ce que fait le code et comment il le fait. Lorsque vous décidez des informations à inclure, demandez-vous ce dont vous auriez besoin d'être informé sur le programme si quelqu'un d'autre l'avait écrit et maintenant on vous demandait de l'exécuter et de le maintenir.

La plupart des programmes que vous écrivez auront plus d'une page de code. Chaque page de code sera enregistrée en tant que fichier programme PHP. (filename.php3) Il y a deux endroits dans le fichier programme où vous voudrez ajouter des commentaires informatifs.

  1. En haut de chaque fichier de programme, vous trouverez des informations générales sur le programme.

    • Tout en haut du fichier et juste après la balise PHP d'ouverture, vous mettrez le nom du fichier tel que HelloWorld.php3.
    • Ensuite, vous ajouterez un avis de copyright vous désignant comme le propriétaire du copyright du programme.
    • Si votre programme aura plus d'une page de code, vous mentionnerez qu'il s'agit d'une page d'un programme plus grand et donnez le nom de ce programme.
    • Vous voudrez également inclure une brève description de l'objectif du programme et de son fonctionnement.
    • Enfin, vous ajouterez tout avis de non-responsabilité et de licence. Par exemple, cela pourrait être une licence écrite par votre avocat ou la licence publique générale GNU que vous êtes libre d'utiliser sur n'importe lequel de vos programmes gratuits. Vous pouvez télécharger une copie de cette licence sur le site Web de la Free Software Foundation. Nous en discuterons plus en détail dans un didacticiel distinct.

  2. La deuxième zone où vous souhaitez ajouter des commentaires se trouve dans le code lui-même au début de chaque section principale de code. Incluez un bref commentaire sur la tâche que cette section particulière effectuera.
Il existe trois façons d'ajouter des commentaires à votre code de programme.

// commentaires allez ici
Ceci est le commentaire de style PHP de base. Tout ce qui se trouve sur la même ligne et qui vient après les deux // sera ignoré par le serveur et non traité comme code de programme.

# commentaires aller ici
Ceci est le commentaire de style shell. Tout ce qui se trouve sur la même ligne et qui vient après le # sera ignoré par le serveur et non traité comme code de programme.

/*
les commentaires vont ici
les commentaires vont ici
les commentaires vont ici
*/
Ceci est le commentaire de style C. Tout ce qui se trouve entre l'ouverture / * et la fermeture * / sera ignoré par le serveur et ne sera pas traité comme code de programme. Vous pouvez utiliser ce style lorsque vous avez plusieurs lignes de commentaires, comme nous l'avons vu dans ce didacticiel. Cliquez ici pour un exemple.




PHP #23 Créer un blog, ajouter des commentaires (Janvier 2022)



Tags Article: Comment ajouter des commentaires à votre programme PHP, PHP, PHP, pages Web dynamiques, langages de script Web, php, bases de données relationnelles, MySQL, PHP version 4, programmation php, didacticiels php, articles php, ressources php, Apache, code source, développement Web , Webmasters, référence, astuces, applications, bases php, balises php, variables, opérateurs

Messages De Beauté Populaires

Choisissez une méthode de méditation

Choisissez une méthode de méditation

religion et spiritualité

Le bon journal de voyage

Le bon journal de voyage

beauté et soi

L'ennemi est parmi vous

L'ennemi est parmi vous

religion et spiritualité