Ausführliche Erläuterung der Schritte zur Verwendung der PHP-Kommentarsyntaxspezifikationen und Namenskonventionen

Dieses Mal erkläre ich Ihnen ausführlich die Schritte zur Verwendung der PHP-Annotation-Syntaxspezifikationen und Namenskonventionen. Welche Vorsichtsmaßnahmen gelten für die Verwendung der PHP-Annotation-Syntaxspezifikationen und Namenskonventionen? Im Folgenden finden Sie praktische Fälle. Werfen wir einen Blick darauf.

HP-Kommentarspezifikation

Kommentare sind beim Schreiben von Code sehr wichtig. Gute Kommentare können die Lesbarkeit Ihres Codes erleichtern . Achten Sie auf die Angabe von Kommentaren.

„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 Funktion oder Methode Rückgabeinformationen* @see Definieren Sie die Funktionen und Variablen, auf die verwiesen werden muss, und fügen Sie 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 zur Datei, Angabe des Dateinamens, der Funktion, der Versionsnummer des Autors und anderer Informationen

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

Dateikopf Vorlage

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

2. Klassenkommentare, Klassenname und Einführung

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

rreee

3. Funktionskommentare, Funktionsfunktion, 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
*/

Programmcode-Kommentare

1. Das Prinzip von Kommentaren besteht darin, das Problem klar zu erklären, nicht je mehr, desto 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: //.

/** 
* 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();}

PHP-Namenskonvention

1. Verzeichnisse und Dateien

Verzeichnisse verwenden Kleinbuchstaben + Unterstrich

für Klassenbibliotheken und Funktionsdateien werden vereinheitlicht mit .php Die Dateinamen von Klassen mit dem Suffix

werden alle mit dem
-Namespace
definiert, und der Pfad des Namespace stimmt mit dem Pfad der Klassenbibliotheksdatei überein Benennen Sie in Kamel-Schreibweise (der erste Buchstabe wird groß geschrieben), andere Dateien werden in Kleinbuchstaben und Unterstrichen benannt. Halten Sie den Klassennamen und den Namen der Klassendatei konsistent und verwenden Sie einheitlich die Kamel-Schreibweise (der erste Buchstabe wird groß geschrieben). )

2. Benennen Sie Funktionen, Klassen und Attribute

Klassen werden in Großbuchstaben benannt (der erste Buchstabe wird großgeschrieben), z. B. User, UserType. Standardmäßig ist kein Suffix erforderlich. UserController sollte beispielsweise direkt User benannt werden.
Funktionen werden in Kleinbuchstaben benannt Buchstaben und Unterstriche (beginnend mit einem Kleinbuchstaben) Beispielsweise verwendet der Name der Methode get_client_ip
Kamelbuchstaben (der erste Buchstabe ist ein Kleinbuchstabe), z. B. getUserName (wenn die Methode einen Rückgabewert hat, ist dies derzeit üblich). Verwenden Sie den ersten Buchstaben in Kleinbuchstaben für den Attributtyp, z. B. s(string), i(int), f (float), b (boolean), a (array) usw.)
Die Benennung von Attributen erfolgt in Camel Groß- und Kleinschreibung (der erste Buchstabe ist ein Kleinbuchstabe), z. B. Tabellenname, Instanz (derzeit ist es üblich, Kleinbuchstaben für den ersten Buchstaben von Attributtypen zu verwenden, z. B. s (Zeichenfolge), i (int), f (Float), b (Boolescher Wert). ), ein (Array) usw.)
Funktionen oder Methoden, die mit einem doppelten Unterstrich „“ beginnen, werden als magische Methoden verwendet, z. B. Aufruf und Autoload

3. Konstanten und Konfigurationen

Konstantennamen 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

4 .Datentabellenfelder

Datentabellen und -felder werden in Kleinbuchstaben benannt und unterstrichen. Beachten Sie, dass Feldnamen 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.

Ich glaube, dass Sie die Methode beherrschen, nachdem Sie den Fall in diesem Artikel gelesen haben. Weitere spannende Informationen finden Sie in anderen verwandten Artikeln auf der chinesischen PHP-Website!

Empfohlene Lektüre:

Detaillierte Erläuterung der Schritte zur Entwicklung eines WeChat-Fernsteuerungsservers mit PHP

Detaillierte Erläuterung der Schritte zur Erstellung ein durchscheinendes Wasserzeichen mit der Funktion imagecopymerge()

Das obige ist der detaillierte Inhalt vonAusführliche Erläuterung der Schritte zur Verwendung der PHP-Kommentarsyntaxspezifikationen und Namenskonventionen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!