Directives de spécification pour les commentaires standard dans les programmes PHP

En tant que langage relativement facile à démarrer, de nombreuses personnes peuvent facilement démarrer avec PHP, mais dans le processus d'apprentissage, vous devez également respecter les spécifications de commentaires standard de PHP.

Nous écrivons souvent certaines fonctions, mais ces fonctions peuvent être comprises uniquement par nous-mêmes. Après un certain temps, nous pouvons même ne pas reconnaître ce que nous avons écrit. Alors, que devons-nous faire ? Le meilleur moyen est bien sûr d’ajouter des commentaires à votre code.

Nous connaissons peut-être de nombreuses façons d'écrire des commentaires, des commentaires C pear PHP, etc., mais les principales que nous utilisons sont # et /**/.

# est une méthode de commentaire court. Peut-être que vous l'utiliserez pour annoter une variable ou appeler une méthode. /**/. Nous pouvons toujours l'utiliser pour commenter. une grande section de code, mais comment l'utiliser pour annoter une fonction de manière standard ?

/**
* @name name
* @abstract declare variable/class/method
* @access spécifie l'autorisation d'accès de cette variable, classe, fonction/méthode
* @author name et email de la fonction author Adresse

* @category Organization packages
* @copyright Spécifiez les informations de copyright
* @const Spécifiez les constantes
* @deprecate Spécifiez les informations obsolètes ou obsolètes
* @example Exemple
* @exclude indique que l'annotation actuelle ne sera pas analysée et n'apparaîtra pas dans le document
* @final indique qu'il s'agit d'une classe, d'une méthode ou d'un attribut final, et que la dérivation et la modification sont interdites.
* @global précise les variables globales référencées dans cette fonction
* @include précise les informations des fichiers inclus
* @link définit la connexion en ligne
* @module définit les informations du module attribué
* @modulegroup définit le groupe de modules appartenant
* @package définit les informations du package appartenant
* @param définit les informations sur les paramètres de la fonction ou de la méthode
* @return définit les informations de retour de la fonction ou de la méthode
* @see définit les fonctions et variables qui doivent être référencées, et ajoute les hyperliens correspondants.
* @since indique à partir de quelle version la fonction ou la méthode API a été introduite
* @static indique que les variables, les classes et les fonctions sont statiques.
* @throws indique les exceptions d'erreur que cette fonction peut générer et les circonstances dans lesquelles elles se produisent
* @todo indique les domaines qui devraient être améliorés ou non implémentés
* @var définit les variables/attributs.
* @version définit les informations de version
*/

Les informations contenues dans les annotations sont très complètes. Il se peut qu'il y en ait beaucoup que nous n'utilisons pas. Les parties rouges sont celles que nous utilisons souvent. .

Exemple :

Modèle d'en-tête de fichier

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

Commentaire d'en-tête de fonction

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

Commentaires de classe

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

Commentaires sur le code du programme

1 Le principe des commentaires est d'expliquer clairement le problème et plus c'est. pas mieux.

2. Plusieurs instructions sont utilisées comme bloc de code logique, et les commentaires de ce bloc peuvent être /* */.

3. Pour les commentaires spécifiques à une certaine déclaration, vous pouvez utiliser des commentaires de fin de ligne : //.

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

Recommandations associées :

Annotations en PHP, annotations PHP

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!