PHP-Kommentare, Include/Include_once, Require/Require_once

By: Fiona Braun Fiona Braun
Hours Aktualisiert

Warum Kommentare verwenden?

  • Wenn Sie längere Zeit nicht am Quellcode arbeiten, kann es leicht passieren, dass Sie vergessen, was der Code tut. Das Kommentieren des Quellcodes hilft dabei, sich daran zu erinnern, was der Code bewirkt.
  • 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 Best Practice gilt, dass Sie pro 3 Codezeilen drei Kommentarzeilen haben müssen

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.
  • PHP-Kommentare
  • Mehrzeilige Kommentare beginnen mit einem Schrägstrich gefolgt vom Sternchen /* und enden mit dem Sternchen gefolgt vom Schrägstrich */.
  • PHP-Kommentare

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

PHP-Beispiel

Beispiel für PHP-Kommentare

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 Datei eingeschlossen werden soll.

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 einschließt
  • „'file_name'“ ist der Name der einzubindenden Datei.

Beispiel: Include / Include_once

Angenommen, Sie entwickeln eine Website, die auf allen Seiten dasselbe Navigationsmenü enthält.

Sie können einen gemeinsamen Header erstellen und ihn dann mit der Include-Anweisung in jede Seite einfügen. Sehen wir uns an, wie das geht.

  • Wir werden 2 Dateinamen erstellen
  • header.php, index.php

Nachfolgend finden Sie die Codes 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 obige Kopfzeile wird ausgegeben

PHP Require & PHP require_once

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

Die Anweisung „require/require_once“ wird zum Einschließen der Datei verwendet.

Require_once wird ignoriert, wenn die erforderliche 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 einschließt
  • „'file_name'“ ist der Name der einzubindenden Datei.

Beispiel: Erforderlich

Angenommen, wir entwickeln 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 erfordert. 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 / require

Umfassen Erfordern
Gibt eine Warnung aus, wenn ein Fehler auftritt Gibt keine Warnung aus
Die Ausführung des Skripts wird fortgesetzt, wenn ein Fehler auftritt Die Ausführung des Skripts stoppt, wenn ein Fehler auftritt.

Generell empfiehlt sich die Verwendung der Include-Anweisung, damit bei Auftreten eines Fehlers bei der Ausführung des Skripts weiterhin 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 in jeder Zeile des Quellcodes verwendet werden, in der der Code erscheinen soll.

Zusammenfassung

  • Einzelner HTML-Code wie Kopf- und Fußzeilen, Seitenleisten usw. kann auf vielen Seiten gemeinsam genutzt werden. Dies macht es einfach, die Website zu aktualisieren, indem nur eine einzelne Datei aktualisiert wird.
  • PHP-Code B. Datenbankkonfigurationseinstellungen, benutzerdefinierte Funktionen usw. können auf vielen Seiten gemeinsam genutzt werden, um sicherzustellen, dass die Website/Anwendung dieselben Einstellungen verwendet.
  • Kommentare werden verwendet, um das Verständnis des Quellcodes zu erleichtern. Sie dienen dem menschlichen Verständnis
  • Einzeilige Kommentaranweisungen beginnen mit doppelten Schrägstrichen //.
  • Mehrzeilige Kommentaranweisungen werden zwischen /*-Anweisungen */ eingeschlossen.
  • Die Anweisungen „include, include_once, require und require_once“ werden zum Einbinden von Dateien verwendet.
  • Include_once/require_once wird ignoriert, wenn die angeforderte Datei bereits mit einer der vier Anweisungen eingebunden wurde.
  • Die „include“-Anweisung gibt eine Warnung aus und fährt mit der Ausführung fort, wenn die angeforderte Datei nicht gefunden wurde.
  • Die require-Anweisung löst einen schwerwiegenden Fehler aus und stoppt die Skriptausführung.
  • Die „include“-Anweisung sollte in den meisten Fällen verwendet werden, außer in Situationen, in denen das gesamte Skript ohne die angeforderte einzubindende Datei nicht ausgeführt werden kann.

Du magst vielleicht: