Spezifikationsrichtlinien für Standardkommentare in PHP-Programmen

Da es sich um eine relativ einfach zu erlernende Sprache handelt, können viele Menschen problemlos mit PHP beginnen. Beim Lernen müssen Sie sich jedoch auch an die Standardkommentarspezifikationen von PHP halten.

Wir schreiben oft einige Funktionen, aber diese Funktionen verstehen möglicherweise nur wir selbst. Nach einer Weile erkennen wir möglicherweise nicht einmal, was wir geschrieben haben. 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 Variable/Klasse/Methode deklarieren
* @access gibt die Zugriffsberechtigung dieser Variablen, Klasse, Funktion/Methode an
* @Autorname und E-Mail-Adresse der Funktion Autorenadresse

* @category Organisationspakete
* @copyright Geben Sie Copyright-Informationen an
* @const Geben Sie Konstanten an
* @deprecate Geben Sie 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 globalen Variablen an, auf die in dieser Funktion verwiesen wird
* @include gibt die Informationen der enthaltenen Dateien 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 diese Funktion auslösen kann, und die Umstände, unter denen sie auftreten
* @todo gibt Bereiche an, die verbessert oder nicht implementiert werden sollten
* @var definiert Variablen/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:

Datei-Header-Vorlage

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

Funktions-Header-Kommentar

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

Klasse Kommentare

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

Kommentare zum Programmcode

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: //.

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

Verwandte Empfehlungen:

Annotationen in PHP, PHP-Annotationen

Das obige ist der detaillierte Inhalt vonSpezifikationsrichtlinien für Standardkommentare in PHP-Programmen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!