Documentation PHP sur les standards de codage (collection)

Afin d'améliorer l'efficacité du travail, de garantir l'efficacité et la rationalité du développement, de maximiser la lisibilité et la réutilisabilité du code du programme et d'améliorer l'efficacité de la communication, une spécification d'écriture de code est nécessaire. Laissez chacun développer de bonnes habitudes de codage et réduire les bugs dans le code.
CleverCode a compilé quelques spécifications. Cette spécification inclut les conventions de dénomination, les règles d'indentation du code, les structures de contrôle, les appels de fonctions, les définitions de fonctions, les commentaires, les codes inclus, les balises PHP et les règles de dénomination courantes dans le codage de programme pendant le développement PHP.

1 Format de fichier

1.1 Balise de fichier

Tous les fichiers PHP utilisent des balises PHP complètes pour leurs balises de code. Il n'est pas recommandé d'utiliser des balises courtes, telles que :

<?php  
//推荐  
echo &#39;hello world&#39;;  
?>  
  
  
<?  
//短标签格式不推荐  
echo &#39; hello world &#39;;  
?>

1) L'utilisation du format de balise courte est facile à confondre avec XML, et toutes les versions et tous les serveurs PHP ne prennent pas en charge ou n'activent pas l'option de balise courte par défaut (à partir de PHP5.4, l'option de balise courte dans php.ini n'affecte pas l'utilisation des balises courtes). Pour les fichiers contenant uniquement du code PHP, le ?> à la fin du fichier sera ignoré. Ceci permet d'éviter que des espaces supplémentaires ou d'autres caractères n'affectent le code.

2) En fait, ce problème ne se produit que lorsque la compression ou la sortie en cache n'est pas activée, par exemple :
php.ini-disable la sortie compressée et la sortie en cache

zlib.output_conpression = off
output_buffering = off

foo .php, veuillez noter qu'il y a des espaces ou des caractères de nouvelle ligne après cela. Bien sûr, cela ne peut pas être vu sur la page.

index.php, tout en incluant foo.php, génère en fait des espaces ou des nouvelles lignes.

<?php  
    $foo= &#39;foo&#39;;  
?>

Vous verrez un avertissement : "...Cannotsendsessioncachelimiter-headersalreadysent..."

<?php  
    include &#39;foo.php&#39;;  
    session_start();  
?>

1.2 Dénomination des fichiers et des répertoires

Programme les noms de fichiers et de répertoires doivent être nommés dans un anglais significatif. N'utilisez pas de pinyin ou de lettres dénuées de sens. Seuls les lettres, les chiffres, les caractères soulignés et soulignés sont autorisés et doivent se terminer par ".php" (sauf les fichiers modèles).

//Les classes utilisent uniformément

DemoTest.php



2 Conventions de dénomination

2.1 Dénomination des variables

Les variables en PHP utilisent un le signe dollar est suivi du nom de la variable. Les noms de variables sont sensibles à la casse. Un nom de morphing valide commence par une lettre ou un trait de soulignement, suivi d'un nombre quelconque de lettres, de chiffres ou de traits de soulignement. L'

expression régulière

normale sera exprimée comme : [a-zA-Z_x7f-xff][a-zA-ZO-9_'x7f-xff], les caractères non-ASCII tels que le chinois ne doivent pas être utilisés dans variables. 2.1.1 L'ensemble du programme

L'ensemble du programme est nommé en casse chameau, commençant par une lettre minuscule, et le nom doit être significatif, tel que :

2.1.2 Valeur de clé de variable globale PHP

function displayName($name){  
    echo $name;  
}

La valeur de clé de variable globale PHP a un deuxième prénom des deux côtés et utilise la dénomination en casse chameau.

2.1.3 Variables ordinaires

Les variables ordinaires utilisent la casse chameau dans son ensemble,

sont nommées selon la convention et évitent d'utiliser des mots-clés courants ou des mots aux significations ambiguës. Les variables doivent être basées sur des noms.

String:$myName
Array:$myArray

Non recommandé :
$yes : elle ne doit pas être utilisée comme variable booléenne car la variable est susceptible d'être modifiée, ce qui peut entraîner Syeszflase, ce qui rend sa logique de code déroutante.
$sex : Un mot anglais avec une signification vague et peu authentique. Le nom du genre devrait être $gender.

2.1.4 Noms des fonctions

Les noms des fonctions doivent être significatifs afin que vous sachiez ce qu'elles vont faire en un coup d'œil, et ils doivent également être abrégés autant que possible. Il est recommandé d'utiliser une méthode de dénomination du verbe ou du verbe plus adjectif

, telle que showMsg. Le nom de fonction suivant n'est pas recommandé :

Le nom de fonction ci-dessus peut être affiné en :

getPublishedAdvertisementBy
CategoryAndCategoryldAndPosition()

Par exemple 1) Fonction publique de classe :

getAd($category,$categoryid，$position,$published)

Par exemple 2) Fonction privée de classe, commençant par "_":

public function doGetUserName($job)

private function _doGetUserName($job)

Par exemple 3) Fonction protégée de classe, commençant par "_":

2.1.5 Attributs de la classe

protected function _doGetUserName($job)

Les variables de la classe suivent les règles de dénomination des variables ordinaires.

Par exemple 1) Attributs publics, attributs statiques :

Par exemple 2) Attributs privés, commençant par "_" :

public $userName = ’CleverCode’;
static $userType = array(1,2,3);

Par exemple 3 ) Attributs protégés, commençant par "_" :

private $_userName = ’CleverCode’;

Par exemple 4) Constantes, toutes en majuscules, séparées par "_" :

protected $_userName = ’CleverCode’;

2.2 Nommage de la base de données

const TYPE_GZ = 4;

2.2.1 Nommage de la bibliothèque

1) Utilisez des lettres minuscules. (Windows n'est pas sensible à la casse et Linux est sensible à la casse. Pour la compatibilité du portage de la bibliothèque, toutes les lettres minuscules sont utilisées)

2) Il se compose de plusieurs mots, séparés par "_".

Par exemple :

2.2.2 Nommage des tables

db_user,db_system。

1) Utilisez des lettres minuscules pour les noms de tables.

2) Les noms de tables utilisent un préfixe unifié, et le préfixe ne peut pas être vide (modulaire et peut effectivement éviter les mots réservés MYSQL).

3) Pour les noms de tables composés de plusieurs mots, utilisez les intervalles "_".
Par exemple :

2.2.3 Dénomination des champs de table

pre_users,pre_user_shop

1)全部使用小写字母命名。
2)多个单词不用下画线进行分割（重要）。
3)如果有必要，给常用字段加上表名首字母作为前缀。
4)避免使用关键字和保留字，但约定俗成的除外。
例如：

username,newsid,userid，logid

3 注释规范

3.1 文件注释

文件注释通常放在整个PHP文件头部，其内容包括文件版权、作者、编写日期、版本号等
重要信息。PHP中，可以参照phpdocument规范，便于利用程序自动生成文档。
文件注释遵循以下规则：
1)必须包含本程序的描述；
2)必须包含作者；
3)必须包含版权；
4)必须包含文件的名称；
5)可以包含书写日期；
6)可以包含版本信息；
7)可以包含重要的使用说明，如类的调用方法、注意事项等。
例如：

<?php  
  
  
/**  
 * SystemUser.php  
 *   
 * 系统用户操作操作  
 *  
 * Copyright (c) 2015 http://blog.csdn.net/CleverCode  
 *  
 * modification history:  
 * --------------------  
 * 2015/5/11, by Clever Code, Create  
 *

3.2 类与接口注释

类和接口的注释应该尽量简洁。按照一般的习惯，一个文件只包含一个类，在类注释中通常不需要再加上作者和版本等信息，加上可见性和简中的描述即可。如果文件注释已经足够详细,可以不用给类写注释。如果同时存在接口和接口的实现类，通常做法是仅在接口中进行注释。

3.3 方法和函数注释

方法和函数的注释写在前面，通常需要标明的信息主要是可见性、参数类型和返回值的类
例如1：

/** 
  * 对比新旧数据 
  * 
  * @param bigint $userid 人编号 
  * @param array $oldMap 旧数据 
  * @param array $newMap 新数据（输出参数） 
  * @return string 成功返回'OK'，失败返回错误信息 
  */  
 public static function diffRecommendInfo($userid, $oldMap, &$newMap){  
 }

例如2：

/** 
  * 插入日志数据 
  * 
  * @param bigint $data[‘userid’] 用户编号 
  * @param array $data[‘logintime’] 登录时间 
  * @return string 成功返回'OK'，失败返回错误信息 
  */  
 public static function insertLogData($data){  
 }

3.4 Action注释

由于我们都是使用的zend开发模式，在Action是http请求处理逻辑的入口，那么必然会传递get,post等参数。可以注释如下.
例如1）没有get,post传递参数时候：

/** 
     * 自动设置名称 
     * 
     * @return void 
     */  
    public function autosetAction(){  
}

例如2 ）有get传递参数时候：

/** 
     * 获取用户名称 
     * 
     * @get int $userid 用户编号 
     * @get int $currpage 当前页 
     * @get int $pagesize 
     * 
     * @return void 
     */  
public function getusernameAction(){  
}

例如3） 有post传递参数时候：

/** 
     * 删除用户 
     * 
     * @post int $userid 用户编号 
     * @return void 
     */  
public function deleteuserAction(){  
}

3.5 单行注释

1)写在被注释代码前面，而不是后面。但对于单行语句，按照习惯可以把注释放在语句末尾,也可以写在行上面。
2)对于大段注释，使用/**/格式，通常在文件和函数注释中使用，而代码内部统一使用//注释，因为其写起来简单。
例如：
//姓名

$name = ’CleverCode’;

4 代码风格

4.1 缩进与空格

在书写代码的时候，必须注意代码的缩进规则：
1)使用4个空格作为缩进，而不使用tab缩进（如在UltraEdit中可以进行预先设置）。
2)变量赋值时，等号左右留出空格。
例如：
$name = 'CleverCode';//推荐
$name='CleverCode';//不推荐

为了最大程度减轻工作量，保持代码美观，建议使用大型IDE管理代码。比如，在zend studio中，使用Ctrl+Shift+F组合键对代码进行格式化。

4.2 语句断行

代码书写中应遵循以下原则：
1)尽量保证程序语句一行就是一句；
2)尽量不要使一行的代码太长，一般控制在80个字符以内；
如果一行代码太长，请使用类似.=的方式断行书写；
执行数据库的SQL语句操作时，尽量不要在函数内写SQL语句，而先用变量定义SQL
语句，然后在执行操作的函数中调用定义的变量。
例如：

//代码分割
$sql= "SELECTusername,password,address,age,postcode from test_t";
$sql.= "WHEREusername=${user}";
$ret = mysql_query($sql);

3)一个函数控制在200行以内；
4)if最多嵌套3层；
//不推荐

If(){  
    If(){  
        If(){  
            If(){  
                ……  
            }  
        }  
    }  
}

5)循环最多3层。

//不推荐  
For(){  
    For(){  
        For(){  
            For(){  
                ……  
            }  
        }  
    }  
}

6)if或者for语句块中只有一行时候，加上{}。当有语句变动的时候会带来不必要的bug。

//推荐  
If($a == 1){  
    echo 1;  
}  
  
//不推荐  
If($a == 1) echo 1;

4.3 空行

1）函数与函数之间空行。
2）同一个函数不同逻辑块之间空行，查阅不同的逻辑块条理更清晰。

4.4 函数结构

通常一个函数分为三部分。第一部分：检查参数；第二部分：处理逻辑；第三部分：返回结果。
例如：

/** 
 * 删除日志通过uid 
 * 
 * @param string $uid 用户uid 
 * @return string 成功返回'OK'，失败返回错误信息 
 */  
public static function deleteLogByUid($uid){  
  
  
    //第一步：检查参数。防止处理部分异常；比如$uid是传入array();  
    if (!is_numeric($uid)) {  
        return '!is_numeric($uid)';  
    }  
      
    //第二步：处理逻辑。  
    $affected = $userLogTable->delete('where userid = ' . $uid);  
      
    //第三步：返回结果。让调用者知道是否处理正常。  
    if($affected){  
        return 'OK';  
    }  
      
    return 'delete error!';  
}

4.5 函数返回函数

需要客户端的函数：
返回值

$ret = array(‘code’=> 1 ,msg=>’’,data => array());

4.6 更好的习惯

在代码中，使用下面列举的写法，可以使代码更优雅。
1)多使用PHP中已经存在的常量，而不要自己定义，例如：

echo$meg."\r\n";
echo$msg,PHPJEOL;

PHP中，PHP_EOL是一个预定义常量，表示一行结束，随着所使用系统的不同，使用PHP_EOL会让代码更具有可移植性。

2)更详尽的注释。
注释是一门艺术，好的注释可以比代码更精彩。不用担心效率问题。一则注释对代码的效
率影响不大，其次在正式产品中可以对代码中的注释进行批量删除。注释做到极致和完美的典型代表是Apache组织各种产品的源代码。

3)不要滥用语法糖。
语法糖也就是语言中的潜规则，即不具有普遍代表性的语法。少量使用语法糖会尝到甜
头，大量使用则是一种灾难。
例如以下代码，可读性比较差；

$a?$a-$b:3&&$c&&$d=1;

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!