PHP-opmerkingen, Include/Include_once, Require/Require_once

Waarom opmerkingen gebruiken?

• Als je een tijdje niet aan de broncode werkt, vergeet je gemakkelijk wat de code doet. Door de broncode van commentaar te voorzien, blijf je beter onthouden wat de code doet.
• Het becommentariëren van de broncode is ook erg belangrijk als meerdere ontwikkelaars aan hetzelfde project moeten werken. De wijzigingen die door de ene ontwikkelaar zijn aangebracht, kunnen gemakkelijk door andere ontwikkelaars worden begrepen door simpelweg de opmerkingen te lezen.
• Het is aan te raden om 3 regels commentaar te gebruiken voor elke 10 regels code.

PHP-opmerkingen

• Opmerkingen helpen ons de code te begrijpen
• Opmerkingen zijn toelichtingen die we in onze broncode opnemen. Deze opmerkingen zijn bedoeld voor menselijk begrip.
• Eenregelige commentaren beginnen met dubbele schuine strepen // en eindigen op dezelfde regel.
• 
• Commentaar op meerdere regels begint met een schuine streep gevolgd door het sterretje /* en eindigt met het sterretje gevolgd door de schuine streep */.
• 

Het onderstaande diagram toont een PHP-bestand met zowel commentaarregels die meerdere regels bevatten als commentaarregels die slechts één regel bevatten.

PHP-voorbeeld

PHP Include & PHP Include_once

De PHP-instructie "include" wordt gebruikt om andere bestanden in een PHP-bestand op te nemen.

Er zijn twee varianten: `include` en `include_once`. `include_once` wordt door de PHP-interpreter genegeerd als het bestand dat moet worden opgenomen al eerder is opgenomen.

De include-instructie heeft de volgende syntaxis

<?php
include 'file_name';
?>

De include_once-instructie heeft de volgende syntaxis

<?php
include_once 'file_name';
?>

HIER,

• “include/include_once” is de instructie die het bestand includeert.
• 'file_name' is de naam van het bestand dat moet worden opgenomen.

Voorbeeld: Include / Include_once

Stel dat u aan het ontwikkelen bentping Een website die op alle pagina's hetzelfde navigatiemenu gebruikt.

Je kunt een algemene header maken en deze vervolgens op elke pagina opnemen met behulp van de `include`-instructie. Laten we eens kijken hoe dit kan.

• We gaan 2 bestanden aanmaken met de naam
• header.php, index.php

Hieronder staat de code voor 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';

?>

De headerpagina hierboven toont de navigatielinks.

PHP Require & PHP require_once

De require-instructie heeft twee varianten: require en require_once.

De `require`/`require_once`-instructie wordt gebruikt om een ​​bestand te includeren.

`require_once` wordt genegeerd als het vereiste bestand al is toegevoegd door een van de vier `include`-instructies.

Het heeft de volgende syntaxis

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

HIER,

• “require/require_once” is de instructie die het bestand includeert.
• 'file_name' is de naam van het bestand dat moet worden opgenomen.

Voorbeeld: Vereisen

Stel dat we aan het ontwikkelen zijnping een databasegestuurde applicatie.

We kunnen een configuratiebestand maken dat we kunnen opnemen in alle pagina's die verbinding maken met de database met behulp van de require-instructie. config.php

<?php

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

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

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

$config['password'] = '';

?>

Laten we nu eens kijken naar de voorbeeldcode die het configuratiebestand vereist. Pagina's_model.php

<?php

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

//other code for connecting to the database

?>

PHP include versus vereisen

Het verschil tussen 'include' en 'require' wordt hieronder weergegeven.

Over het algemeen wordt aangeraden om de include-instructie te gebruiken, zodat bij een fout de uitvoering van het script doorgaat en het e-mailadres van de webmaster of de contactpagina wordt weergegeven.

De require-instructie moet worden gebruikt als het hele script niet kan worden uitgevoerd zonder het opgevraagde bestand.

De instructies "include" en "require" kunnen op elke regel in de broncode worden gebruikt waar u de code wilt laten verschijnen.

PHP-documentatiecommentaren (PHPDoc)

Naast commentaarregels van één of meerdere regels, gebruiken PHP-ontwikkelaars PHPDoc-blokcommentaren om functies en klassen te documenteren. Een PHPDoc-blok begint met /** en gebruikt tags zoals @param en @return die IDE's lezen om hints en autocomplete weer te geven.

<?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 verandert niets aan de werking van de code, maar het verduidelijkt de bedoeling van elke functie en stelt tools in staat om automatisch API-documentatie te genereren. Door het toe te voegen aan gedeelde bestanden, zoals de configuratie- en helperbestanden hierboven, blijft een groeiende codebase beter onderhoudbaar.

Veelgestelde vragen