Comentarii PHP, Include/Include_once, Require/Require_once

De ce să folosiți Comentarii?

• Dacă nu lucrezi la codul sursă o perioadă de timp, este ușor să uiți ce face codul. Comentariile la codul sursă te ajută să-ți amintești ce face codul.
• Comentarea codului sursă este, de asemenea, foarte importantă atunci când mai mulți dezvoltatori trebuie să lucreze la același proiect. Modificările făcute de un dezvoltator pot fi ușor de înțeles de către alți dezvoltatori prin simpla citire a comentariilor.
• Ca regulă generală, ar trebui să aveți 3 rânduri de comentarii pentru fiecare 10 rânduri de cod.

Comentarii PHP

• Comentariile ne ajută să înțelegem codul
• Comentariile sunt explicații pe care le includem în codul sursă. Aceste comentarii sunt pentru înțelegerea umană.
• Comentariile pe o singură linie încep cu bare oblice duble // și se termină pe aceeași linie.
• 
• Comentariile pe mai multe rânduri încep cu o bară oblică urmată de asterisc /* și se termină cu asteriscul urmat de bara oblică */.
• 

Diagrama de mai jos prezintă un fișier PHP cu comentarii atât pe mai multe linii, cât și pe o singură linie.

Exemplu PHP

PHP Include și PHP Include_once

Instrucțiunea PHP „include” este utilizată pentru a include alte fișiere într-un fișier PHP.

Are două variante, include și include_once. include_once este ignorată de interpretorul PHP dacă fișierul care trebuie inclus a fost deja inclus.

Instrucțiunea include are următoarea sintaxă

<?php
include 'file_name';
?>

Instrucțiunea include_once are următoarea sintaxă

<?php
include_once 'file_name';
?>

AICI,

• „include/include_once” este instrucțiunea care include fișierul
• „'file_name'” este numele fișierului care va fi inclus.

Exemplu: Include / Include_once

Să presupunem că ești dezvoltatping un site web care conține același meniu de navigare pe toate paginile.

Puteți crea un antet comun, apoi să îl includeți în fiecare pagină folosind instrucțiunea include. Să vedem cum se poate face acest lucru.

• Vom crea 2 fișiere numite
• header.php, index.php

Mai jos este codul pentru 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';

?>

Pagina de antet de mai sus va afișa linkurile de navigare.

PHP Require și PHP require_once

Declarația require are două variante, require și require_once.

Instrucțiunea require/require_once este utilizată pentru a include un fișier.

require_once este ignorată dacă fișierul necesar a fost deja adăugat de oricare dintre cele patru instrucțiuni de includere.

Are următoarea sintaxă

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

AICI,

• „require/require_once” este instrucțiunea care include fișierul
• „'file_name'” este numele fișierului care va fi inclus.

Exemplu: Cere

Să presupunem că suntem dezvoltațiping o aplicație bazată pe baze de date.

Putem crea un fișier de configurare pe care îl putem include în toate paginile care se conectează la baza de date folosind instrucțiunea require. config.php

<?php

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

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

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

$config['password'] = '';

?>

Să analizăm acum exemplul de cod care necesită fișierul de configurare. Pagini_model.php

<?php

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

//other code for connecting to the database

?>

PHP include vs require

Diferența dintre include și require este prezentată mai jos.

În general, se recomandă utilizarea instrucțiunii include, astfel încât, atunci când apare o eroare, execuția scriptului să continue să afișeze adresa de e-mail a webmasterului sau pagina de contact.

Declarația require ar trebui să fie utilizată dacă întregul script nu poate rula fără fișierul solicitat.

Instrucțiunile „include” și „require” pot fi utilizate în orice linie din codul sursă unde doriți să apară codul.

Comentarii la documentația PHP (PHPDoc)

Dincolo de comentariile pe o singură linie sau pe mai multe linii, dezvoltatorii PHP folosesc comentariile în blocurile PHPDoc pentru a documenta funcții și clase. Un bloc PHPDoc începe cu /** și folosește etichete precum @param și @return pe care IDE-urile le citesc pentru a afișa indicii și a completa automat.

<?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 nu schimbă modul în care rulează codul, dar clarifică intenția fiecărei funcții și permite instrumentelor să genereze automat documentația API. Adăugarea sa la fișierele partajate, cum ar fi fișierele de configurare și de ajutor de mai sus, menține o bază de cod în creștere ușor de întreținut.

Întrebări frecvente