Detaillierte Erläuterung der Syntaxspezifikationen und Namenskonventionen für PHP-Kommentare

Kommentare sind beim Schreiben von Code sehr wichtig. Beim Schreiben von Code müssen Sie auf die Spezifikationen von Kommentaren achten beziehen Sie sich 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 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/

Die Informationen in den Anmerkungen sind sehr umfassend. Es kann sein, dass wir viele Informationen nicht verwenden. 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
*/

Kommentare zum Programmcode

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

sind alle in Namespaces definiert, und der Pfad des Namespace stimmt mit dem Pfad der Klassenbibliotheksdatei überein
Klassendateien werden in Kamel-Schreibweise benannt (der erste). Der Name der Klasse und der Klassendatei sollten konsistent sein und einheitlich die Kamel-Schreibweise verwenden (der erste Buchstabe wird groß geschrieben)

2 , Klassen und Attributbenennung

Klassennamen sollten die Kamel-Schreibweise verwenden (der erste Buchstabe wird großgeschrieben), z. B. User, UserType, es ist nicht erforderlich, standardmäßig ein Suffix hinzuzufügen. UserController sollte beispielsweise direkt sein benannter Benutzer

. Verwenden Sie Kleinbuchstaben und Unterstriche (beginnend mit einem Kleinbuchstaben) für die Benennung der Methode get_client_ip

(Der erste Buchstabe ist Kleinbuchstabe), z. B. getUserName (wenn die Methode einen Rückgabewert hat, ist es derzeit üblich, den ersten Buchstaben in Kleinbuchstaben für Attributtypen wie s (string), i (int), f (float), b (boolean), a (array) usw. zu verwenden.)

Verwenden Sie die Kamel-Schreibweise für die Benennung von Attributen (der erste Buchstabe ist ein Kleinbuchstabe), z. B. Tabellenname, Instanz (derzeit ist es üblich, Attributtypen in Kleinbuchstaben für den 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 und Konfigurationen

Konstanten werden mit Großbuchstaben und Unterstrichen benannt, z. B. APP_PATH und THINK_PATH

Konfigurationsparameter werden mit Kleinbuchstaben und Unterstrichen benannt, z. B. url_route_on und url_convert

4 Feldfelder

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

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