Leçon 7 : Commenter ses scripts

Peut-être avez-vous remarqué que les scripts PHP deviennent inintelligibles. Dans cette leçon, nous verrons pourquoi les commentaires sont importants et comment les fondre dans vos scripts.

Pourquoi les commentaires sont-il importants ?

Lorsque vous codez, vous écrivez des instructions pour un serveur ou un ordinateur et vous devez employer un langage hautement formel qui ne reflétera pas clairement vos pensées au moment de l'élaboration du script.

D'autres personnes (ou vous-même) auront peut-être des difficultés à comprendre la structure du script et, par conséquent, à identifier et corriger les erreurs qui s'y trouveraient.

On peut utiliser des commentaires dans le script pour fournir des explications succintes. Le serveur ignorera entièrement les commentaires lesquels n'affectent pas le fonctionnement réel du script.

Dans le monde professionnel, les scripts et la programmation sont souvent obligatoirement commentés, pour la bonne raison que, pour une société, les risques seraient trop élevés de reprendre un système dans lequel il est difficile de rechercher et corriger des erreurs.

Comment insérer les commentaires ?

Ce n'est pas compliqué d'insérer un commentaire. Ils commencent tout simplement par deux barres obliques : "//".

Regardez cet exemple de la leçon 5, assorti cette fois de commentaires :


	<html>
	<head>
	<title>Loops</title>
	</head>
	<body>

	<?php

	// Here we write color codes using three loops

	// Red can be between 0 and 255
	for ($intRed=0; $intRed<=255; $intRed=$intRed+30) {

	   // Green can be between 0 and 255
	   for ($intGreen=0; $ intGreen<=255; $intGreen=$intGreen+30) {

	      // Blue can be between 0 and 255
	      for ($ intBlue=0; $intBlue<=255; $intBlue=$intBlue+30) {

	      // The color code is made on the form rgb(red,green,blue)
		  $strColor = "rgb(" . $intRed . "," . $intGreen . "," . $intBlue . ")"

	      // Now we write the color code to the client
		  echo "<span style='color:" . $strColor . "'> " . $strColor . " </span>";

	      // Closes the loops
	      }
	   }
	}

	?>

Pour les besoins de l'exemple, nous avons inclus nombre de commentaires redondants ; clairement, il est bien plus facile de déboguer un script contenant des commentaires que non.

Donc rappelez-vous de commenter vos scripts !

<< Leçon 6 : Les conditions

Leçon 8 : Les tableaux >>