Introduction aux commentaires en PHP
Le mot commentaire lui-même exprime sa signification comme commentant quelque chose. Si nous commentons quelque chose dans le fichier programme PHP, il ne sera pas compilé avec le code. Le compilateur ou l'interpréteur ignorera simplement cela. Il existe différentes façons de commenter quoi que ce soit dans le langage de programmation PHP. PHP a également une option de commentaire sur une seule ligne et plusieurs lignes. De plus, dans le commentaire sur une seule ligne, nous pouvons utiliser le / ou # selon notre convenance. Nous devons toujours écrire la langue appropriée dans le commentaire afin que quiconque examine ce code puisse lire et comprendre ce commentaire.
Syntaxe
Encore une fois, nous pouvons utiliser le commentaire de la manière mentionnée 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 en vue comparativement au code réel. Si nous avons écrit du 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.
echo "This is my first PHP Program";
// this is the first program
?>
Cela ne donnera que "Ceci est mon premier programme PHP" en sortie, pas la partie commentaire.
Pourquoi devrions-nous utiliser des commentaires?
Nous devons utiliser le commentaire entre le code du programme PHP pour nous assurer d'avoir suffisamment de commentaires d'aide pour que l'on puisse facilement lire et comprendre le code. En commentaire, nous pouvons également dans le but d'écrire le segment du code, changer la date, la date de modification, modifié par, etc. Il est fortement recommandé pour un développeur d'utiliser le commentaire dans le code de programmation afin 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 un exemple rapide pour vérifier le comportement du commentaire dans le programme.
Exemple 1
<_?phpecho "This is my first PHP Program";
// this is the first program
?>
Production
Exemple # 2
Commentaire sur une seule ligne dans le programme
Code:
<_?phpecho date_default_timezone_get(); //to get the timezone
echo "
"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>
Production
Exemple # 3
Commentaire multi-lignes 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 "
";
echo hoursandmins(120);
?>
Production
Tous les commentaires écrits avant toute fonction à propos de cette fonction sont communément appelés documentation de la 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 disent 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 # 4
Commentaire mitigé
Dans un fichier programme PHP, nous pouvons combiner PHP et HTML. Compte tenu de cela, nous utiliserons la méthode de commentaire HTML pour commenter la partie HTML chaque fois que nécessaire, et les commentaires PHP peuvent être utilisés pour le code lié à PHP selon les exigences de l'entreprise. Nous pouvons utiliser tout type de commentaires PHP et les commentaires HTML dans un fichier PHP-HTML.
Code:
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
PHP with HTML
echo "Hello World!"; // this is PHP comment
?>
Production
Exemple # 5
Commentaire sur une seule ligne en utilisant #
Nous pouvons également utiliser la ligne de commentaire en utilisant le #. Voyons un exemple du code pour le même. Nous pouvons voir que cette ligne de commentaires n'est pas très populaire. Très peu de développeurs utilisent ce type de commentaires. Ceci est vraiment recommandé pour tout en commentant la documentation de la fonction ou la documentation au niveau du fichier.
Code:
<_?php# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
Production
Conclusion - Commentaires en PHP
Un commentaire est vraiment un appel au temps dans le code. Nous pouvons utiliser le commentaire dans notre fichier programme PHP. Cela nous aidera à rendre le code plus compréhensible. Nous devrions 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 a appelé la documentation de cette fonction ou de la classe.
Articles recommandés
Ceci est un guide des commentaires en PHP. Ici, nous discutons de l'introduction, comment cela fonctionne-t-il, pourquoi nous devrions utiliser les commentaires ainsi que les exemples et les résultats. Vous pouvez également consulter nos autres articles suggérés pour en savoir plus–
- Mots-clés Python
- Tableau d'impression en Java
- Qu'est-ce que XPath?
- Héritage en PHP