Zusammenfassende gemeinsame Nutzung der Syntaxspezifikationen und Namenskonventionen für PHP-Kommentare

In diesem Artikel teilen wir Ihnen die PHP-Kommentarsyntaxspezifikationen und Namenskonventionen mit. Wir wissen, dass Kommentare beim Schreiben von Code sehr wichtig sind. Sie müssen darauf achten es beim Schreiben von Annotationsspezifikationen. Ich hoffe, dieser Artikel kann allen helfen.

HP-Kommentarspezifikation

Kommentare sind beim Schreiben von Code sehr wichtig. Gute Kommentare können das Lesen Ihres Codes erleichtern Dabei ist auf die Angabe von Kommentaren zu achten.

„Ein Anfänger, der gerade erst angefangen hat, kann mit Echo in weniger als ein paar Minuten eine „Hallo Welt“ ausdrucken. Wie macht man das? Wie sieht es mit der Definition eines Programmierers aus? Wenn Sie wirklich Programmierer werden möchten, müssen Sie eine Reihe von Standards für das Schreiben von Programmen befolgen von uns selbst, und sogar Es ist schon eine Weile her, seit ich nicht mehr erkannt habe, was ich geschrieben habe, also was soll ich tun? Der beste Weg ist natürlich, Kommentare zu Ihrem Code hinzuzufügen.

Wir sind vielleicht mit vielen Möglichkeiten zum Schreiben von Kommentaren, C-Pear-PHP-Kommentaren usw. vertraut, aber die wichtigsten, die wir verwenden, sind # und /**/.

# ist eine kurze Kommentarmethode. Vielleicht verwenden Sie es, um eine Variable zu kommentieren oder eine Methode aufzurufen. /**/. Wir verwenden es möglicherweise immer noch zum Kommentieren einen großen Codeabschnitt aus, aber wie kann man damit eine Funktion standardmäßig mit Anmerkungen versehen?

/**

* @name name

* @abstract deklariert eine Variable/Klasse/Methode
* @access gibt die Zugriffsrechte dieser Variablen, Klasse, Funktion/Methode an
* @author der Name und die E-Mail-Adresse von die Funktion Autor Adresse

* @category Organisationspakete

* @copyright Gibt Copyright-Informationen an

* @const Gibt Konstanten an
* @deprecate Gibt veraltete oder veraltete Informationen an
* @example Beispiel
* @exclude gibt an, dass die aktuelle Annotation nicht analysiert wird und nicht im Dokument erscheint
* @final gibt an, dass es sich um eine endgültige Klasse, Methode oder ein endgültiges Attribut handelt und Ableitung und Änderung verboten sind.
* @global gibt die globale Variable an, auf die in dieser Funktion verwiesen wird
* @include gibt die Informationen der eingebundenen Datei an
* @link definiert die Online-Verbindung
* @module definiert die attributierten Modulinformationen
* @modulegroup definiert die zugehörige Modulgruppe
* @package definiert die zugehörige Paketinformation
* @param definiert die Parameterinformationen der Funktion oder Methode
* @return definiert die Rückgabeinformationen der Funktion oder Methode
* @see definiert die Funktionen und Variablen, auf die verwiesen werden muss, und fügt die entsprechenden Hyperlinks hinzu.
* @since gibt an, aus welcher Version die API-Funktion oder -Methode eingeführt wurde.
* @static gibt an, dass Variablen, Klassen und Funktionen statisch sind.
* @throws gibt die Fehlerausnahmen an, die von dieser Funktion ausgelöst werden können, und die Umstände, unter denen sie auftreten
* @todo gibt Bereiche an, die verbessert oder nicht implementiert werden sollten
* @var definiert Beschreibungsvariablen/ Attribute.
* @version definiert Versionsinformationen
*/

Die Informationen in den Anmerkungen sind möglicherweise sehr umfassend. Die roten Teile sind diejenigen, die wir häufig verwenden .

Beispiel: Mehrere gängige Kommentarmethoden in PHP:

1. Kommentare zu Dateien, Einführung von Dateinamen, Funktionen, Autorenversionsnummern und anderen Informationen

Datei-Header-Vorlage

/**
* 文件名简单介绍
* 
* 文件功能
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

2. Klassenkommentare, Klassenname und Einleitung

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author   richard<e421083458@163.com> 
* @version   $Id$ 
* @since    1.0 
*/

/**
* 类的介绍
* 
* 类的详细介绍（可选）
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

3. Funktionskommentare, Funktionsfunktionen, Parametereinführung und Rückgabetyp

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author     richard<e421083458@163.com> 
* @since     1.0 
*/ 
class Test  
{ 
}

Funktionsheader Kommentare

/**
* 函数的含义说明
* 
* @access public 
* @author 作者
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明
* @return array 返回类型
* @date 2020-02-02
*/

/** 
* some_func 
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @return array 
*/ 
public function thisIsFunction($string, $integer, $mixed) {return array();}

Kommentare zum Programmcode

1 Kommentare Das Prinzip besteht darin, das Problem zu erklären Offensichtlich ist nicht mehr besser.

2. Mehrere Anweisungen werden als logischer Codeblock verwendet, und die Kommentare dieses Blocks können /* */ sein.

3. Für Kommentare, die sich speziell auf eine bestimmte Aussage beziehen, können Sie End-of-Line-Kommentare verwenden: //.

/* 生成配置文件、数据文件。*/ 
 
$this->setConfig(); 
$this->createConfigFile(); //创建配置文件 
$this->clearCache();     // 清除缓存文件 
$this->createDataFiles();  // 生成数据文件 
$this->prepareProxys(); 
$this->restart();

PHP-Namenskonvention

1. Verzeichnisse und Dateien

Verzeichnisse verwenden Kleinbuchstaben + Unterstrich

Klassenbibliotheken und Funktionsdateien erhalten einheitlich das Suffix .php

Die Dateinamen der Klassen sind alle in Namespaces definiert, und der Pfad des Namespace stimmt mit dem Pfad der Klassenbibliotheksdatei überein
Klassendateien werden benannt unter Verwendung der Kamel-Schreibweise (der erste Buchstabe wird groß geschrieben), andere Dateien werden in Kleinbuchstaben + Unterstrich benannt
Der Klassenname und der Klassendateiname sind konsistent und verwenden einheitlich die Kamel-Schreibweise (der erste Buchstabe wird groß geschrieben)

2 . Funktionen und Klassen, Attributbenennung

Bei der Klassenbenennung wird die Kamel-Schreibweise verwendet (der erste Buchstabe wird großgeschrieben), z. B. User, UserType, und es ist standardmäßig kein Suffix erforderlich. UserController sollte beispielsweise direkt benannt werden Benutzer

. Funktionsnamen sollten Kleinbuchstaben und Unterstriche verwenden (beginnend mit einem Kleinbuchstaben), z. B. Die Methode get_client_ip

wird in Kamelbuchstaben benannt (der erste Buchstabe ist Kleinbuchstaben), z. B. getUserName (falls die Methode vorhanden ist). Als Rückgabewert ist es derzeit üblich, für den Attributtyp den ersten Buchstaben in Kleinbuchstaben zu verwenden, z. B. s (string), i (int), f (float), b(boolean), a(array) usw.)
Bei der Benennung von Attributen wird die Kamel-Schreibweise verwendet (der erste Buchstabe ist ein Kleinbuchstabe), z. B. Tabellenname, Instanz (derzeit ist es üblich, Attributtypen in Kleinbuchstaben mit dem ersten Buchstaben zu verwenden, z. B. s( string), i(int), f(float), b(boolean), a(array) usw.)
Funktionen oder Methoden, die mit dem doppelten Unterstrich „__“ beginnen, werden als magische Methoden verwendet, wie zum Beispiel __call und __autoload

3. Konstanten und Konfiguration

Konstanten werden mit Großbuchstaben und Unterstrichen benannt, wie zum Beispiel APP_PATH und THINK_PATH
Konfigurationsparameter werden mit Kleinbuchstaben und Unterstrichen benannt, wie zum Beispiel url_route_on und url_convert

Datentabellenfelder

Datentabellen und -felder werden in Kleinbuchstaben benannt und unterstrichen, und Feldnamen sollten nicht mit einem Unterstrich beginnen, wie z. B. die Tabelle „think_user“ und das Feld „user_name“. Es wird nicht empfohlen, Kamelbuchstaben und Chinesisch als Feldnamen für Datentabellen zu verwenden.

Verwandte Empfehlungen:

So entfernen Sie alle Kommentare in Webdateien in PHP

Details zu Schreibmethoden und Kommentaren in Einführung in JavaScript

Standardverwendung von HTML-, CSS- und JS-Kommentaren

Das obige ist der detaillierte Inhalt vonZusammenfassende gemeinsame Nutzung der Syntaxspezifikationen und Namenskonventionen für PHP-Kommentare. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!