Spécifications de la syntaxe des commentaires PHP et conventions de dénomination

Les commentaires sont très importants dans le processus d'écriture de code. De bons commentaires peuvent rendre votre code plus facile à lire. Lors de l'écriture de code, vous devez faire attention aux spécifications des commentaires. Ici, l'éditeur de Script House le triera pour vous. Les amis dans le besoin peuvent s'y référer.

Spécification des commentaires HP

Les commentaires sont très importants dans le processus d'écriture de code. De bons commentaires peuvent rendre votre code plus facile à lire lors de l'écriture. code, veillez à faire attention à la spécification des commentaires.

« PHP est un langage extrêmement simple avec lequel débuter. Un novice qui vient de commencer pourra peut-être utiliser echo pour imprimer un bonjour tout le monde en moins de quelques minutes ! Comment faire ? Qu'en est-il de la définition d'un programmeur ? Si vous voulez vraiment devenir un programmeur, vous devez suivre un ensemble de normes d'écriture de programmes "

Nous écrivons souvent certaines fonctions, mais ces fonctions peuvent seulement être comprises. par nous-mêmes, et même Cela fait un moment que je n'ai pas reconnu ce que j'ai écrit, alors que dois-je 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 名字
* @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 定义版本信息
*/

Les informations contenues dans les annotations sont très complètes. Il peut y avoir beaucoup d'informations que nous n'utilisons pas. Les parties rouges sont celles que nous utilisons souvent.

Exemple : Plusieurs méthodes de commentaires courantes en php :

1. Commentaires sur le fichier, introduisant le nom du fichier, la fonction, le numéro de version de l'auteur et d'autres informations

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

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

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

2. Commentaires de classe, nom de classe et introduction

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

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

3. Commentaires de fonction, fonction, introduction de paramètre et type de retour

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

Commentaires 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 sur le code du programme

1 Le principe des commentaires est de poser le problème Expliquez. il est clair que plus n’est pas toujours 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();

Convention de dénomination PHP

1. Répertoires et fichiers

Utiliser des lettres minuscules. pour les répertoires + soulignement
Bibliothèque de classes, les fichiers de fonctions sont uniformément suffixés par .php
Les noms de fichiers de classe sont définis dans les espaces de noms, et le chemin de l'espace de noms est cohérent avec le chemin du fichier de bibliothèque de classes
Fichiers de classe sont nommés en majuscule (la première lettre est en majuscule), les autres fichiers sont nommés en minuscules + souligné
Le nom de la classe et le nom du fichier de classe sont cohérents et la méthode de la casse en chameau est uniformément utilisée (la première lettre est en majuscule)

2. Fonctions et classes, dénomination des attributs

Les classes sont nommées en utilisant la casse camel (la première lettre est en majuscule), comme User, UserType Par défaut, aucun suffixe n'est requis. Par exemple, UserController doit être directement nommé User
Les fonctions sont nommées en utilisant des lettres minuscules et des traits de soulignement (commençant par une lettre minuscule). Par exemple, le nom de la méthode get_client_ip
utilise la casse camel (la première lettre est en minuscule), comme getUserName (si la méthode a une valeur de retour, il est actuellement d'usage d'utiliser la première lettre en minuscule pour le type d'attribut, comme s(string), i(int ), f (float), b (boolean), a (tableau), etc.)
La dénomination des attributs utilise la casse chameau (la première lettre est minuscule), comme tableName, instance (il est actuellement d'usage d'utiliser des minuscules pour la première lettre des types d'attributs, comme s (string), i (int), f (float), b (boolean), a (array), etc.)
Les fonctions ou méthodes commençant par un double trait de soulignement "__" sont utilisées comme méthodes magiques, telles que __call et _ _autoload

3. Constantes et configurations

Les constantes sont nommées avec des lettres majuscules et des traits de soulignement, tels que APP_PATH et THINK_PATH
Les paramètres de configuration sont nommés avec des lettres minuscules et des traits de soulignement, tels que url_route_on et url_convert

4. Champs de la zone de table de données

Les tables et champs de données sont nommés en minuscules et soulignés, et veillez à ne pas commencer le nom du champ par un trait de soulignement, comme think_user table et user_name field. . Il n'est pas recommandé d'utiliser la casse camel et le chinois pour la dénomination des champs.