Partage récapitulatif des spécifications de syntaxe des commentaires PHP et des conventions de dénomination

Dans cet article, nous partagerons avec vous les spécifications de la syntaxe des commentaires PHP et les conventions de dénomination. Nous savons que 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 du code. J'espère que cet article pourra aider tout le monde.

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 du code. faire attention à la spécification des commentaires ce faisant.

« PHP est un langage extrêmement simple avec lequel démarrer. 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 name
* @abstract déclare une variable/classe/méthode
* @access précise les droits d'accès de cette variable, classe, fonction/méthode
* @author le nom et l'email de la fonction auteur Adresse

* @category Packages d'organisation
* @copyright Spécifie les informations de copyright
* @const Spécifie les constantes
* @deprecate Spécifie 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 la variable globale référencée dans cette fonction
* @include précise les informations du fichier 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 de description.
* @version définit les informations de version
*/

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

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

1. Commentaires sur les fichiers, présentant les noms de fichiers, les fonctions, les numéros 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, fonctions de fonction, introduction des paramètres et type de retour

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

En-tête de fonction commentaires

/** 
* 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

Commentaires Le principe est d'expliquer le problème. de toute évidence, pas plus, c'est 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

Les répertoires utilisent des minuscules + un trait de soulignement<.>Les bibliothèques de classes et les fichiers de fonctions sont uniformément suffixés par .php
Les noms de fichiers des classes sont tous définis dans des espaces de noms, et le chemin de l'espace de noms est cohérent avec le chemin du fichier de bibliothèque de classes
Les fichiers de classe sont nommés en utilisant la casse camel (la première lettre 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 utilisent uniformément la casse camel (la première lettre est en majuscule)

2 . Fonctions et classes, dénomination des attributs

La dénomination des classes utilise la casse camel (la première lettre est en majuscule), telle que User, UserType, et aucun suffixe n'est requis par défaut. Par exemple, UserController doit être directement nommé. Utilisateur

. Les noms de fonction doivent utiliser des lettres minuscules et des traits de soulignement (commençant par une lettre minuscule), par exemple. La méthode get_client_ip
est nommée en utilisant la casse camel (la première lettre est 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(array), etc.)
La dénomination des attributs utilise la casse camel (la première lettre est minuscule), comme tableName, instance (il est actuellement d'usage d'utiliser des types d'attributs minuscules avec la première lettre, 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 configuration

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

Champs de la boîte de table de données

.

Les tables de données et les champs sont nommés en minuscules et soulignés, et les noms de champs ne doivent pas commencer par un trait de soulignement, comme la table think_user et le champ user_name. Il n'est pas recommandé d'utiliser la casse camel et le chinois comme noms de champs de table de données.

Recommandations associées :

Comment supprimer tous les commentaires dans les fichiers Web en php

Détails des méthodes d'écriture et des commentaires dans JavaScript Présentation de l'

utilisation standard des commentaires html, css et js

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!