Commentaires PHP, Include/Include_once, Require/Require_once

Pourquoi utiliser les commentaires ?

• Si vous ne travaillez pas sur le code source pendant un certain temps, il est facile d'oublier son fonctionnement. Commenter le code source vous aide à vous en souvenir.
• Commenter le code source est également très important lorsque plusieurs développeurs doivent travailler sur le même projet. Les modifications apportées par un développeur peuvent être facilement comprises par d'autres développeurs en lisant simplement les commentaires.
• Il est recommandé d'avoir 3 lignes de commentaires pour 10 lignes de code.

Commentaires PHP

• Les commentaires nous aident à comprendre le code
• Les commentaires sont des explications que nous incluons dans notre code source. Ces commentaires sont destinés à la compréhension humaine.
• Les commentaires sur une seule ligne commencent par deux barres obliques // et se terminent sur la même ligne.
• 
• Les commentaires sur plusieurs lignes commencent par une barre oblique suivie de l'astérisque /* et se terminent par l'astérisque suivi de la barre oblique */.
• 

Le diagramme ci-dessous illustre un fichier PHP contenant des commentaires multilignes et des commentaires sur une seule ligne.

Exemple PHP

PHP Inclure et PHP Include_once

L'instruction PHP « include » est utilisée pour inclure d'autres fichiers dans un fichier PHP.

Il existe deux variantes : `include` et `include_once`. `include_once` est ignorée par l’interpréteur PHP si le fichier à inclure l’a déjà été.

L'instruction include a la syntaxe suivante

<?php
include 'file_name';
?>

L'instruction include_once a la syntaxe suivante

<?php
include_once 'file_name';
?>

ICI,

• « include/include_once » est l'instruction qui inclut le fichier
• « 'nom_du_fichier' » est le nom du fichier à inclure.

Exemple : Include / Include_once

Supposons que vous soyez développeurping un site web dont le menu de navigation est identique sur toutes les pages.

Vous pouvez créer un en-tête commun, puis l'inclure dans chaque page à l'aide de l'instruction include. Voyons comment procéder.

• Nous allons créer 2 fichiers nommés
• en-tête.php, index.php

Ci-dessous le code pour header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

La page d'en-tête ci-dessus affichera les liens de navigation.

PHP requiert et PHP require_once

L'instruction require a deux variantes, require et require_once.

L'instruction require/require_once est utilisée pour inclure un fichier.

La fonction require_once est ignorée si le fichier requis a déjà été ajouté par l'une des quatre instructions include.

Il a la syntaxe suivante

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ICI,

• « require/require_once » est l'instruction qui inclut le fichier
• « 'nom_du_fichier' » est le nom du fichier à inclure.

Exemple : Exigence

Supposons que nous soyons en développementping une application basée sur une base de données.

Nous pouvons créer un fichier de configuration que nous pouvons inclure dans toutes les pages qui se connectent à la base de données à l'aide de l'instruction require. config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

Examinons maintenant l'exemple de code qui nécessite le fichier de configuration. Pages_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP inclure vs exiger

La différence entre include et require est illustrée ci-dessous.

En règle générale, il est recommandé d'utiliser l'instruction include afin que, lorsqu'une erreur se produit, l'exécution du script continue d'afficher l'adresse électronique du webmaster ou la page « Nous contacter ».

L'instruction require doit être utilisée si l'intégralité du script ne peut pas s'exécuter sans le fichier demandé.

Les instructions « include » et « require » peuvent être utilisées à n'importe quelle ligne du code source où vous souhaitez que le code apparaisse.

Commentaires sur la documentation PHP (PHPDoc)

Outre les commentaires mono-ligne et multilignes, les développeurs PHP utilisent les blocs de commentaires PHPDoc pour documenter les fonctions et les classes. Un bloc PHPDoc commence par /** et utilise des balises telles que @param et @return que les IDE lisent pour afficher des suggestions et proposer l'autocomplétion.

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

PHPDoc ne modifie pas le fonctionnement du code, mais il clarifie la fonction de chaque élément et permet aux outils de générer automatiquement la documentation de l'API. Son intégration aux fichiers partagés, tels que les fichiers de configuration et d'assistance mentionnés précédemment, facilite la maintenance d'un code source en constante évolution.

FAQ