Commentaires en PHP

Le mot commentaire lui-même exprime sa signification comme commentant quelque chose. Si nous commentons quoi que ce soit dans le fichier programme PHP, il ne sera pas compilé avec le code. Le compilateur ou l'interpréteur l'ignorera simplement. Il existe différentes manières de commenter n'importe quoi dans le langage de programmation PHP. PHP propose également des options de commentaires sur une seule ligne et sur plusieurs lignes. De plus, dans le commentaire sur une seule ligne, nous pouvons utiliser le / ou le # selon notre convenance. Nous devons toujours écrire le langage approprié dans le commentaire afin que toute personne qui révise ce code puisse lire et comprendre ce commentaire.

Commencez votre cours de développement de logiciels libres

Développement Web, langages de programmation, tests de logiciels et autres

Syntaxe

Encore une fois, nous pouvons utiliser le commentaire des manières mentionnées ci-dessous en PHP.

Commentaire sur une seule ligne :

// This is a single-line comment
# This is a single-line comment
/*
This is a multiple line comment – line no – 1
This is a multiple line comment – line no – 2
… and so on …
*/
# this is the single-line comment
; this is a PHP.INI style commenting

Comment fonctionnent les commentaires en PHP ?

Au moment où nous écrivons le commentaire dans le code, il sera plus clair comparativement au code réel. Si nous avons écrit le code et le commentaire dans le même fichier, dans ce cas, le commentaire ne sera pas exécuté lors de l'exécution de ce fichier PHP. Voyons donc la même chose avec un exemple.

<?PHP
echo "This is my first PHP Program";
// this is the first program
?>

Cela donnera uniquement « Ceci est mon premier programme PHP » en sortie, pas la partie commentaire.

Pourquoi devrions-nous utiliser les commentaires ?

Nous devrions utiliser le commentaire entre le code du programme PHP pour nous assurer que nous avons suffisamment de commentaires d'aide afin que l'on puisse facilement lire et comprendre le code. En commentaire, on peut aussi dans le but d'écrire le segment du code, changer la date, la date de modification, modifié par, etc. Il est fortement recommandé à un développeur d'utiliser le commentaire dans le code de programmation pour que les choses puissent être comprises. facilement avec peu ou pas d'effort chaque fois que nécessaire.

Exemples

Maintenant, il est temps de voir quelques exemples rapides pour vérifier le comportement du commentaire dans le programme.

Exemple n°1

<?php
echo "This is my first PHP Program";
// this is the first program
?>

Sortie 

Exemple n°2

Commentaire sur une seule ligne dans le programme

Code :

<?php
echo date_default_timezone_get(); //to get the timezone
echo "<br>"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>

Sortie 

Exemple #3

Commentaire multiligne dans le programme

Code :

<?php
/*
This is a function that will take time in minutes and will return that in hours and minutes
We use will this function further to test with some examples.
*/
function hoursandmins($minutes, $format = '%01d Hours, %02d Minutes')
{
if ($minutes < 1) {
return;
}else if($minutes<10){
if($minutes==1){
return '0'.$minutes.' Minute';
}
return '0'.$minutes.' Minutes';
}else if($minutes<50){
return $minutes.' Minutes';
}
$hours = floor($minutes / 60);
$minutes = ($minutes % 60);
$format = "";
if($hours>0){
if($hours>1){
$format .= '%01d Hours';
}else{
$format .= '%01d Hour';
}
}
if($hours>0 && $minutes>0){
$format .= ', ';
}
if($minutes>0){
if($minutes>1){
$format .= ' %02d Minutes';
}else{
$format .= ' %01d Minute';
}
}
return sprintf($format, $hours, $minutes);
}
// time to check the time in descriptive form
echo hoursandmins(20);
echo "<br>";
echo hoursandmins(120);
?>

Sortie 

Tous les commentaires écrits avant toute fonction concernant cette fonction sont communément appelés documentation de fonction. Ainsi, dans les scénarios donnés, nous pouvons dire ce commentaire comme un document de fonction. C'est vraiment sympa d'utiliser le commentaire comme ça. Pour rendre le programme PHP plus robuste, nous avons diverses normes PHP qui stipulent que nous ne devons pas utiliser le commentaire à l'intérieur de la fonction, car nous pouvons faire de même dans la documentation de la fonction.

Exemple n°4

Commentaire mitigé

Dans un fichier de programme PHP, nous pouvons combiner à la fois PHP et HTML. Compte tenu de cela, nous utiliserons la méthode de commentaire HTML pour commenter la partie HTML chaque fois que cela est nécessaire, et les commentaires PHP peuvent être utilisés pour le code associé à PHP selon les exigences commerciales. Nous pouvons utiliser n'importe quel type de commentaires PHP et les commentaires HTML dans un fichier PHP-HTML.

Code :

<html>
<body>
<h1>PHP with HTML</h1>
<!-- this is html comment -->
<?php
echo "Hello World!"; // this is PHP comment
?>
</body>
</html>

Sortie 

Exemple #5

Commentaire sur une seule ligne en utilisant #

Nous pouvons également utiliser les commentaires sur une seule ligne en utilisant le #. Voyons un exemple du code correspondant. Nous pouvons voir que cette ligne de commentaires n’est pas très populaire. Très peu de développeurs utilisent ce genre de commentaires. Ceci est vraiment recommandé pour le moment en commentant la documentation des fonctions ou la documentation au niveau du fichier.

Code :

<?php
# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>

Sortie

Conclusion

Un commentaire est vraiment un appel du temps dans le code. Nous pouvons utiliser le commentaire dans notre fichier programme PHP. Cela nous aidera à rendre le code plus compréhensible. Nous devons utiliser le commentaire avant de démarrer une fonction ou la classe car la plupart des langages de programmation ont leur propre standard de code. Habituellement, le commentaire avant toute fonction ou classe appelle la documentation de cette fonction ou de cette classe.

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!