PHP komentari, Include/Include_once, Require/Require_once

Zašto koristiti komentare?

• Ako neko vrijeme ne radite na izvornom kodu, lako je zaboraviti što kod radi. Komentariranje izvornog koda pomaže vam da se sjetite što kod radi.
• Komentiranje izvornog koda također je vrlo važno kada više programera mora raditi na istom projektu. Promjene koje je napravio jedan programer mogu lako razumjeti drugi programeri jednostavnim čitanjem komentara.
• Kao najbolja praksa, trebali biste imati 3 retka komentara na svakih 10 redaka koda.

PHP komentari

• Komentari nam pomažu da razumijemo kod
• Komentari su objašnjenja koja uključujemo u naš izvorni kod. Ovi komentari su za ljudsko razumijevanje.
• Jednoredni komentari počinju s dvostrukim kosim crtama // i završavaju u istom retku.
• 
• Komentari u više redaka počinju kosom crtom nakon koje slijedi zvjezdica /* i završavaju zvjezdicom nakon koje slijedi kosa crta */.
• 

Donji dijagram prikazuje PHP datoteku s komentarima u više redaka i u jednom retku.

PHP primjer

PHP Uključi & PHP Uključi_jednom

PHP naredba "include" koristi se za uključivanje drugih datoteka u PHP datoteku.

Ima dvije varijacije, include i include_once. PHP interpreter ignorira include_once ako je datoteka koju treba uključiti već uključena.

Izjava include ima sljedeću sintaksu

<?php
include 'file_name';
?>

Naredba include_once ima sljedeću sintaksu

<?php
include_once 'file_name';
?>

OVDJE,

• „include/include_once“ je naredba koja uključuje datoteku
• „'naziv_datoteke'” je naziv datoteke koju treba uključiti.

Primjer: Uključi / Uključi_jednom

Pretpostavimo da ste razvijeniping web-stranica koja sadrži isti navigacijski izbornik na svim stranicama.

Možete stvoriti zajednički zaglavlje, a zatim ga uključiti na svaku stranicu pomoću naredbe include. Pogledajmo kako se to može učiniti.

• Napravit ćemo 2 datoteke pod nazivom
• zaglavlje.php, index.php

Ispod je kod za 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';

?>

Navigacijske poveznice će se prikazati na gornjoj zaglavnoj stranici.

PHP Require & PHP require_once

Naredba require ima dvije varijacije, require i require_once.

Naredba require/require_once koristi se za uključivanje datoteke.

require_once se zanemaruje ako je potrebna datoteka već dodana bilo kojom od četiri include naredbe.

Ima sljedeću sintaksu

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

OVDJE,

• „require/require_once“ je naredba koja uključuje datoteku
• „'naziv_datoteke'” je naziv datoteke koju treba uključiti.

Primjer: Zahtijevati

Pretpostavimo da se razvijamoping aplikacija koja se pokreće bazom podataka.

Možemo izraditi konfiguracijsku datoteku koju možemo uključiti u sve stranice koje se povezuju s bazom podataka pomoću naredbe require. config.php

<?php

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

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

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

$config['password'] = '';

?>

Pogledajmo sada primjer koda koji zahtijeva konfiguracijsku datoteku. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP uključuje protiv zahtjeva

Razlika između include i require prikazana je u nastavku.

Općenito se preporučuje korištenje naredbe include kako bi se u slučaju pogreške, izvršavanje skripte nastavilo prikazivati ​​​​e-mail adresu webmastera ili stranicu za kontakt.

Naredbu zahtijeva treba koristiti ako se cijela skripta ne može pokrenuti bez tražene datoteke.

Naredbe „include“ i „require“ mogu se koristiti u bilo kojem retku izvornog koda gdje želite da se kod pojavi.

Komentari PHP dokumentacije (PHPDoc)

Osim jednolinijskim i višelinijskim komentarima, PHP programeri koriste PHPDoc blok komentare za dokumentiranje funkcija i klasa. PHPDoc blok počinje s /** i koristi oznake poput @param i @return koje IDE-i čitaju za prikaz savjeta i automatsko dovršavanje.

<?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 mijenja način izvođenja koda, ali jasno objašnjava namjeru svake funkcije i omogućuje alatima automatsko generiranje API dokumentacije. Dodavanjem u dijeljene datoteke, kao što su konfiguracijske i pomoćne datoteke gore, održava se rastuća baza koda.

Pitanja i odgovori