PHP-Kommentare, Include/Include_once, Require/Require_once

Warum Kommentare verwenden?

• Wenn man längere Zeit nicht am Quellcode arbeitet, vergisst man leicht, was der Code bewirkt. Kommentare im Quellcode helfen dabei, sich an die Funktion des Codes zu erinnern.
• Das Kommentieren des Quellcodes ist auch dann sehr wichtig, wenn mehrere Entwickler an demselben Projekt arbeiten müssen. Die von einem Entwickler vorgenommenen Änderungen können von anderen Entwicklern leicht verstanden werden, indem sie einfach die Kommentare lesen.
• Als bewährte Vorgehensweise sollten Sie für je 10 Codezeilen 3 Kommentarzeilen einfügen.

PHP-Kommentare

• Kommentare helfen uns, den Code zu verstehen
• Kommentare sind Erläuterungen, die wir in unseren Quellcode einbinden. Diese Kommentare dienen dem menschlichen Verständnis.
• Einzeilige Kommentare beginnen mit doppelten Schrägstrichen // und enden in derselben Zeile.
• 
• Mehrzeilige Kommentare beginnen mit einem Schrägstrich gefolgt vom Sternchen /* und enden mit dem Sternchen gefolgt vom Schrägstrich */.
• 

Das folgende Diagramm zeigt eine PHP-Datei mit mehrzeiligen und einzeiligen Kommentaren.

PHP-Beispiel

PHP Include & PHP Include_once

Die PHP-Anweisung „include“ wird verwendet, um andere Dateien in eine PHP-Datei einzubinden.

Es gibt zwei Varianten, include und include_once. include_once wird vom PHP-Interpreter ignoriert, wenn die einzubindende Datei bereits eingebunden wurde.

Die Include-Anweisung hat die folgende Syntax

<?php
include 'file_name';
?>

Die include_once-Anweisung hat die folgende Syntax

<?php
include_once 'file_name';
?>

HIER,

• „include/include_once“ ist die Anweisung, die die Datei einbindet.
• „'file_name'“ ist der Name der einzubindenden Datei.

Beispiel: Include / Include_once

Angenommen, Sie entwickelnping Eine Website, die auf allen Seiten das gleiche Navigationsmenü verwendet.

Sie können eine gemeinsame Kopfzeile erstellen und diese dann mithilfe der Include-Anweisung auf jeder Seite einbinden. Sehen wir uns an, wie das funktioniert.

• Wir werden 2 Dateien erstellen mit den Namen
• header.php, index.php

Nachfolgend der Code für 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';

?>

Die obenstehende Kopfzeile gibt die Navigationslinks aus.

PHP Require & PHP require_once

Die require-Anweisung gibt es in zwei Varianten: require und require_once.

Die require/require_once-Anweisung wird verwendet, um eine Datei einzubinden.

require_once wird ignoriert, wenn die benötigte Datei bereits durch eine der vier include-Anweisungen hinzugefügt wurde.

Es hat die folgende Syntax

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

HIER,

• „require/require_once“ ist die Anweisung, die die Datei einbindet.
• „'file_name'“ ist der Name der einzubindenden Datei.

Beispiel: Erforderlich

Angenommen, wir entwickelnping eine datenbankgestützte Anwendung.

Mit der require-Anweisung können wir eine Konfigurationsdatei erstellen, die wir in alle Seiten einbinden können, die eine Verbindung zur Datenbank herstellen. config.php

<?php

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

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

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

$config['password'] = '';

?>

Schauen wir uns nun den Beispielcode an, der die Konfigurationsdatei benötigt. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP einschließen vs. erfordern

Der Unterschied zwischen include und require wird im Folgenden erläutert.

Generell empfiehlt es sich, die include-Anweisung zu verwenden, damit bei einem Fehler die Ausführung des Skripts fortgesetzt wird und die E-Mail-Adresse des Webmasters oder die Kontaktseite angezeigt wird.

Die require-Anweisung sollte verwendet werden, wenn das gesamte Skript ohne die angeforderte Datei nicht ausgeführt werden kann.

Die Anweisungen „include“ und „require“ können an jeder beliebigen Stelle im Quellcode verwendet werden, an der der Code erscheinen soll.

PHP-Dokumentationskommentare (PHPDoc)

Neben ein- und mehrzeiligen Kommentaren verwenden PHP-Entwickler PHPDoc-Blockkommentare, um Funktionen und Klassen zu dokumentieren. Ein PHPDoc-Block beginnt mit /** und verwendet Tags wie @param und @return, die von IDEs gelesen werden, um Hinweise und Autovervollständigung anzuzeigen.

<?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 ändert nichts an der Ausführung des Codes, sondern verdeutlicht die Absicht jeder Funktion und ermöglicht es Tools, automatisch API-Dokumentation zu generieren. Durch das Hinzufügen zu gemeinsam genutzten Dateien, wie den oben genannten Konfigurations- und Hilfsdateien, bleibt eine wachsende Codebasis wartungsfreundlich.

Häufig gestellte Fragen