So fügen Sie Ihrem PHP-Programm Kommentare hinzu


Jeder Programmierer hat seine Meinung dazu, welche Informationen im Programmcode enthalten sein sollen. Die meisten Programmierer fügen ihrem Code Kommentare hinzu, um sich und alle anderen daran zu erinnern, was der Code tut und wie er es tut. Fragen Sie sich bei der Entscheidung, welche Informationen aufgenommen werden sollen, was Sie über das Programm wissen müssten, wenn jemand anderes das Programm geschrieben hätte und Sie nun aufgefordert würden, es auszuführen und zu warten.

Die meisten Programme, die Sie schreiben, haben mehr als eine Seite Code. Jede Codeseite wird als PHP-Programmdatei gespeichert. (filename.php3) Es gibt zwei Stellen in der Programmdatei, an denen Sie einige informative Kommentare hinzufügen möchten.

  1. Am Anfang jeder Programmdatei finden Sie allgemeine Informationen zum Programm.

    • Ganz oben in der Datei und direkt nach dem öffnenden PHP-Tag wird der Name der Datei wie HelloWorld.php3 eingefügt.
    • Als Nächstes fügen Sie einen Copyright-Hinweis hinzu, in dem Sie sich als Copyright-Inhaber des Programms angeben.
    • Wenn Ihr Programm mehr als eine Seite Code enthält, werden Sie erwähnen, dass dies eine Seite eines größeren Programms ist, und den Namen dieses Programms angeben.
    • Sie sollten auch eine kurze Beschreibung des Zwecks des Programms und seiner Funktionsweise hinzufügen.
    • Zuletzt fügen Sie alle Haftungsausschluss- und Lizenzinformationen hinzu. Dies kann beispielsweise eine von Ihrem Anwalt verfasste Lizenz oder die GNU General Public License sein, die Sie für jedes Ihrer Freeware-Programme verwenden können. Sie können eine Kopie dieser Lizenz von der Free Software Foundation-Website herunterladen. Wir werden dies in einem separaten Tutorial genauer besprechen.

  2. Der zweite Bereich, in dem Sie Kommentare hinzufügen möchten, befindet sich im gesamten Code am Anfang jedes wichtigen Codeabschnitts. Fügen Sie einen kurzen Kommentar dazu hinzu, welche Aufgabe dieser bestimmte Abschnitt ausführen wird.
Es gibt drei Möglichkeiten, Ihrem Programmcode Kommentare hinzuzufügen.

// Kommentare gehen hier
Dies ist der grundlegende Kommentar im PHP-Stil. Alles in derselben Zeile und das, was nach den beiden // kommt, wird vom Server ignoriert und nicht als Programmcode verarbeitet.

# Kommentare gehen hier
Dies ist der Shell-Kommentar. Alles, was sich in derselben Zeile befindet und nach dem # steht, wird vom Server ignoriert und nicht als Programmcode verarbeitet.

/*
Kommentare gehen hier
Kommentare gehen hier
Kommentare gehen hier
*/
Dies ist der Kommentar im C-Stil. Alles, was sich zwischen dem Öffnen / * und dem Schließen * / befindet, wird vom Server ignoriert und nicht als Programmcode verarbeitet. Sie können diesen Stil verwenden, wenn Sie mehr als eine Kommentarzeile haben, wie wir sie in diesem Tutorial beschrieben haben. Klicken Sie hier für ein Beispiel.




How To add a Custom Domain On Github Pages (Kann 2021)



Tags Artikel: So fügen Sie Ihrem PHP-Programm Kommentare hinzu: PHP, PHP, dynamische Webseiten, Web-Skriptsprachen, PHP, relationale Datenbanken, MySQL, PHP Version 4, PHP-Programmierung, PHP-Tutorials, PHP-Artikel, PHP-Ressourcen, Apache, Quellcode, Webentwicklung , Webmaster, Referenz, Tipps, Anwendungen, PHP-Grundlagen, PHP-Tags, Variablen, Operatoren