PHP Comments, Include/Include_one, Require/Require_one

Miért használja a megjegyzéseket?

• Ha egy ideig nem dolgozol a forráskódon, könnyű elfelejteni, hogy mit csinál a kód. A forráskód kommentelése segít emlékezni arra, hogy mit csinál a kód.
• A forráskód kommentálása akkor is nagyon fontos, ha több fejlesztőnek kell dolgoznia ugyanazon a projekten. Az egyik fejlesztő által végrehajtott változtatásokat a többi fejlesztő könnyen megértheti a megjegyzések elolvasásával.
• Ajánlott gyakorlatként minden 10 sornyi kódhoz 3 sornyi megjegyzést kell használni.

PHP megjegyzések

• A megjegyzések segítenek megérteni a kódot
• A megjegyzések magyarázatok, amelyeket belefoglalunk a forráskódunkba. Ezek a megjegyzések az emberi megértést szolgálják.
• Az egysoros megjegyzések dupla perjellel // kezdődnek, és ugyanabban a sorban végződnek.
• 
• A többsoros megjegyzések perjellel kezdődnek, amelyet a /* követ, és a csillaggal, majd a perjellel */ végződnek.
• 

Az alábbi ábra egy többsoros és egysoros megjegyzéseket tartalmazó PHP fájlt mutat.

PHP példa

PHP Include és PHP Include_once

Az „include” PHP utasítás más fájlok PHP fájlba való beillesztésére szolgál.

Két változata létezik, az include és az include_once. Az include_once-t a PHP értelmező figyelmen kívül hagyja, ha a beillesztendő fájl már szerepel a fájlban.

Az include utasítás szintaxisa a következő

<?php
include 'file_name';
?>

Az include_once utasítás szintaxisa a következő

<?php
include_once 'file_name';
?>

ITT,

• Az „include/include_once” az a parancs, amely tartalmazza a fájlt.
• A „'fájl_neve'” a belefoglalandó fájl neve.

Példa: Include / Include_once

Tegyük fel, hogy fejlesztő vagyping egy olyan weboldal, amelynek minden oldalán ugyanaz a navigációs menü található.

Létrehozhatsz egy közös fejlécet, majd beillesztheted minden oldalba az include utasítással. Nézzük meg, hogyan lehet ezt megtenni.

• Létrehozunk két fájlt, melyek nevei a következők:
• header.php, index.php

Az alábbiakban a következő kód található: 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';

?>

A fenti fejlécoldalon jelennek meg a navigációs linkek.

PHP Require és PHP követelmény_egyszer

A request utasításnak két változata van, a request és a request_once.

A require/require_once utasítás egy fájl beillesztésére szolgál.

A require_once függvényt figyelmen kívül hagyja a rendszer, ha a szükséges fájlt már hozzáadta a négy include utasítás bármelyike.

A következő szintaxissal rendelkezik

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ITT,

• A „require/require_once” az a parancs, amely tartalmazza a fájlt.
• A „'fájl_neve'” a belefoglalandó fájl neve.

Példa: Szükséges

Tegyük fel, hogy fejlődünkping egy adatbázis-alapú alkalmazás.

Létrehozhatunk egy konfigurációs fájlt, amelyet az összes adatbázishoz csatlakozó oldalba belehelyezhetünk a request utasítás segítségével. config.php

<?php

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

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

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

$config['password'] = '';

?>

Most nézzük meg a konfigurációs fájlt igénylő mintakódot. Pages_model.php

<?php

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

//other code for connecting to the database

?>

A PHP tartalmazza a követelményt

Az include és a require közötti különbség az alábbiakban látható.

Általában ajánlott az include utasítás használata, hogy hiba esetén a szkript végrehajtása továbbra is megjelenítse a webmester e-mail címét vagy a kapcsolatfelvételi oldalt.

A request utasítást akkor kell használni, ha a teljes szkript nem futhat a kért fájl nélkül.

Az „include” és a „require” utasítások a forráskód bármely sorában használhatók, ahol a kódot meg szeretnéd jeleníteni.

PHP dokumentációs megjegyzések (PHPDoc)

Az egy- és többsoros megjegyzéseken túl a PHP fejlesztők PHPDoc blokk megjegyzéseket használnak függvények és osztályok dokumentálására. A PHPDoc blokk /** karakterrel kezdődik, és olyan tageket használ, mint a @param és a @return, amelyeket az IDE-k beolvasnak a tippek megjelenítéséhez és az automatikus kiegészítéshez.

<?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;
}
?>

A PHPDoc nem változtatja meg a kód futtatását, de egyértelművé teszi az egyes függvények célját, és lehetővé teszi az eszközök számára, hogy automatikusan generálják az API dokumentációt. Ha hozzáadjuk a megosztott fájlokhoz, például a fenti konfigurációs és segédfájlokhoz, a növekvő kódbázis karbantartható marad.

GYIK