Utilisation des commentaires dans PHP

Utilisation des commentaires dans PHP
Les commentaires sont utilisés avec n'importe quel code source pour expliquer correctement la fonctionnalité du code. Chaque langage de programmation utilise une syntaxe particulière pour ajouter un commentaire dans le code source. Le commentaire n'est pas lu par l'interprète ou le compilateur du langage de programmation. Le codeur n'a pas vraiment besoin d'ajouter des commentaires dans le code, mais il y a deux avantages à utiliser un commentaire dans le code. Un avantage consiste à rendre le code lisible pour que d'autres comprennent correctement le code, et un autre avantage consiste à aider le codeur à rappeler la fonctionnalité du code après une longue période lorsque le code nécessite une modification. La syntaxe de commentaire utilisée dans PHP est similaire à d'autres langages de programmation standard comme C, C ++, Java, etc. Le commentaire peut être une seule ligne et multi-ligne. Comment les commentaires à ligne unique et multi-ligne peuvent être utilisés dans le code PHP sont affichés dans ce tutoriel.

Commentaire unique

Le commentaire à une seule ligne peut être utilisé dans le code PHP en utilisant une syntaxe différente. Deux types de commentaires à une seule ligne du code PHP sont affichés dans ce tutoriel. L'un est la syntaxe de commentaire C ++ / Java, et une autre est une syntaxe de commentaire Shell. Les deux syntaxes de l'utilisation de commentaires en une seule ligne dans PHP sont présentées dans cette section du tutoriel.

Exemple-1: commentaires en une seule ligne utilisant la syntaxe C ++ / Java

Les caractères doubles de hachage ('//') sont utilisés pour commenter une seule ligne dans le script PHP. Dans le script suivant, les cinq commentaires en une seule ligne sont utilisés pour expliquer le code. Ici, des valeurs à trois cordes sont déclarées, et elles sont combinées plus tard dans une autre variable. Un commentaire à une seule ligne est ajouté pour chaque déclaration omise par l'interprète au moment de l'exécution.

// définir la première valeur de chaîne
$ str1 = "bienvenue";
// Définissez la deuxième valeur de chaîne
$ str2 = "à";
// définir la troisième valeur de chaîne
$ str3 = "Linuxhint";
// combine la chaîne avec l'espace
$ str = $ str1."".$ str2."".$ str3;
// imprime la chaîne combinée
écho "

$ str

"
?>

Sortir:

La sortie suivante apparaîtra après avoir exécuté le code. La sortie montre les valeurs combinées de $ str1, $ str2 et $ str3. Tous les commentaires à une seule ligne ont été ignorés par l'interprète.

Exemple-2: commentaires en une seule ligne à l'aide de la syntaxe shell

Le symbole '#' est utilisé pour un commentaire en une seule ligne dans le script shell qui est pris en charge par PHP. Le script PHP suivant calcule si l'année en cours est une année bondante ou non. La fonction personnalisée Isleap () est utilisée ici pour calculer si l'année en cours est une année saut ou non. Le commentaire à une seule ligne est utilisé dans le code pour rendre le script plus lisible pour les lecteurs. Ici, la fonction date () est utilisée pour lire l'année en cours qui est mentionnée dans le commentaire. Ensuite, la fonction mktime () est utilisée pour vérifier si l'année est une année de saut ou non. Si l'année est une année de saut, alors la fonction mktime () reviendra 1, et le caractère de format «l» est utilisé dans la fonction date () pour l'année de saut. Les commentaires à une seule ligne nécessaire sont utilisés dans le script.

# Relevez l'année en cours à partir de la date du système
$ an = date ("y");
#All de la fonction isLeap () et testez la valeur de retour
If (isleap ($ an))

écho "

L'année, $ an est un an année.

"

autre

écho "

L'année, $ l'année n'est pas l'année de saut.

"

#Define une fonction pour vérifier l'année de saut
fonction isleap ($ an)

# Définir l'année est leap ou non
return (date ('l', mktime (0, 0, 0, 1, 1, $ an)) == 1);

?>

Sortir:

La sortie suivante apparaîtra après avoir exécuté le code. La sortie montre que l'année en cours, 2020, est une année de saut, et tous les commentaires à une seule ligne ont été ignorés par l'interprète.

Commentaire multi-lignes

Un commentaire multi-ligne est utilisé pour ajouter un long commentaire de texte. Si le codeur doit expliquer la fonction du code en détail pour une meilleure compréhension, alors il peut ajouter un commentaire en plusieurs lignes pour ce code. Le '/ *' est utilisé au début du commentaire, et '* /' est utilisé à la fin du commentaire. Ce type de commentaire multi-ligne est utilisé dans n'importe quel langage de programmation standard, comme Java, C ++, etc. Un commentaire multi-lignes est principalement utilisé au début de tout script pour fournir des informations détaillées sur le script, le scénariste, la version, le lien du code source, etc.
La façon dont les commentaires multi-lignes sont utilisés dans PHP sont affichés dans l'exemple suivant:

Exemple-3: commentaire multi-lignes en utilisant '/ *… * /'

Dans le script suivant, trois commentaires multi-lignes sont utilisés pour expliquer le code. Le premier commentaire décrit la fonctionnalité du script. Le deuxième commentaire explique la fonction de la fonction rand (). Le troisième commentaire explique le but de la fonction isprime (). Un nombre aléatoire entre 1 et 100 sera généré à chaque fois que le script s'exécute, et la fonction isPrime () découvrira si le nombre est premier ou non. Si la fonction renvoie true, alors le nombre est Prime. Sinon, le nombre n'est pas premier.

/ * Le script suivant testera un numéro particulier
Prime ou non Prime en utilisant une fonction personnalisée
* /
/ * Attribuer un nombre aléatoire entre 1 et 100 en utilisant
Fonction PHP intégrée Rand ()
* /
$ nombre = rand (1 100);
// Vérifiez que le nombre est premier ou non
if (isPrime (numéro $))
écho "

Le numéro de $ est un nombre premier.

"
autre
écho "

Le numéro de $ n'est pas un nombre premier.

"
/ * La fonction renvoie 1 si le nombre aléatoire généré
Le nombre aléatoire est premier et retourne 0 si le nombre n'est pas
prime */
fonction isprime ($ numéro)
if ($ nombre == 1)
retour 0;
pour ($ i = 2; $ i

Sortir:

La sortie du script variera dans chaque exécution en raison du nombre aléatoire. La sortie suivante est apparue après avoir exécuté le code pour la première fois, et il sera modifié dans la prochaine exécution. Si le nombre aléatoire généré est prim.

Conclusion

Chaque script standard contient des commentaires pour aider le lecteur à comprendre correctement le code. De nombreux nouveaux codeurs n'ajoutent pas de commentaires dans leur script qui rend le code difficile à comprendre pour les autres codeurs. Ainsi, lorsque vous écrivez un script, vous devez ajouter des commentaires pour chaque déclaration.