《PHP PSR 标准规范》
2021-01-18 14:12
标签：一起 邮件 条件判断 file 书写规则 password php attribute 静态变量 PHP开发编码规范 编写目的 为了更好的提高技术部的工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，指定此规范。开发团队根据自己的实际情况，可以对本规范进行补充或裁减。 本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。 变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。 变量命名 标记变量的命名： temp 可缩写为 tmp ; flag 可缩写为 flg ; statistic 可缩写为 stat ; increment 可缩写为 inc ; message 可缩写为 msg ; 1) 普通变量 普通变量命名遵循以下规则： a． 所有字母都使用小写； b． 对于一个变量使用多个单词的，使用’_‘作为每个词的间隔。 例如：$base_dir、$red_rose_price等 2) 静态变量 静态变量命名遵循以下规则： a． 静态变量使用小写的s_开头； b． 静态变量所有字母都使用小写； c． 多个单词组成的变量名使用’_‘作为每个词的间隔。 例子：$s_base_dir、$s_red_rose_prise等。 3) 局部变量 局部变量命名遵循以下规则： a． 所有字母使用小写； b． 变量使用’_‘开头； c． 多个单词组成的局部变量名使用’_‘作为每个词间的间隔。 例子：$_base_dir、$_red_rose_price等。 4) 全局变量 全局变量应该带前缀’g‘,知道一个变量的作用域是非常重要的。 例如 global $gLOG_LEVEL; global $gLOG_PATH; 5) 全局常量 全局变量命名遵循以下规则： a． 所有字母使用大写 b． 全局变量多个单词间使用’_‘作为间隔。 例子：$BASE_DIR、$RED_ROSE_PRICE等。 6) session变量 session变量命名遵循以下规则： a． 所有字母使用大写； b． session变量名使用’S_’开头； c． 多个单词间使用’_‘间隔。 例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。 类的常量中所有字母都 必须 大写，词间以下划线分隔 例子：const VERSION = ‘1.0‘;const DATE_APPROVED = ‘2012-06-01‘; PHP 的常量 true， false， 还有 null 必须 使用小写形式。 PHP 类命名 php中类命名遵循以下规则： a． 以大写字母开头； b． 多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。 例子：class MyClass 或class DbOracle等。 PHP 方法或函数 方法或函数命名遵循以下规则： a． 首字母小写； b． 多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。 例子：function myFunction ()或function myDbOracle ()等。 PHP 缩写词 当变量名或者其他命名中遇到缩写词时，参照具体的命名规则，而不采用缩写词原来的全部大写的方式。 例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。 变量自增自减写到表达式前面： --e >= $name 程序顺序应该遵循：参数定义代码->判断逻辑代码->业务逻辑代码 大的数据使用引用 为逻辑代码里每个复杂度高/重复度高的代码添加注释 尽量不为简短代码引入新的变量，减少变量污染 书写规则 PHP 代码缩进 在书写代码的时候，必须注意代码的缩进规则，我们规定代码缩进规则如下： a． 使用4个空格作为缩进，而不使用tab缩进（对于ultraedit，可以进行预先设置） 例子：for ( $i=0;$i
PHP 大括号{ }书写规则 在程序中进行结构控制代码编写，如if、for、while、switch等结构，大括号传统的有两种书写习惯，分别如下： a．{直接跟在控制语句之后，不换行，如 for ($i=0;$i
echo "test"; } b．{在控制语句下一行，如 for($i=0;$i
echo "test"; } 其中，a是PEAR建议的方式，但是从实际书写中来讲，这并不影响程序的规范和影响用phpdoc实现文档，所以可以根据个人习惯来采用上面的两种方式，但是要求在同一个程序中，只使用其中一种，以免造成阅读的不方便。 PHP 小括号( )和函数、关键词等 小括号、关键词和函数遵循以下规则： a． 不要把小括号和关键词紧贴在一起，要用一个空格间隔；如if ( $a
b． 小括号和函数名间没有空格；如$test = date("ymdhis")； c． 除非必要，不要在Return返回语句中使用小括号。 如return $a； PHP ＝符号书写 在程序中=符号的书写遵循以下规则： a． 在=符号的两侧，均需留出一个空格；如$a = $b 、if ($a = = $b)等； b． 在一个申明块，或者实现同样功能的一个块中，要求=号尽量上下对其，左边可以为了保持对齐使用多个空格，而右边要求空一个空格；如下例： $testa = $aaa; $testaa = $bbb; $testaaa = $ccc; PHP if else swith for while等书写 对于控制结构的书写遵循以下规则： a． 在if条件判断中，如果用到常量判断条件，将常量放在等号或不等号的左边，例如： if ( 6 == $errorNum )，因为如果你在等式中漏了一个等号，语法检查器会为你报错，可以很快找到错误位置，这样的写法要多注意； 标准的 if 结构如下代码所示，请留意「括号」、「空格」以及「花括号」的位置， 注意 else 和 elseif 都与前面的结束花括号在同一行。 if ($expr1) { // if body } elseif ($expr2) { // elseif body } else { // else body; } 应该 使用关键词 elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。 b． switch结构中必须要有default块； 标准的 switch 结构如下代码所示，留意「括号」、「空格」以及「花括号」的位置。 case 语句 必须 相对 switch 进行一次缩进，而 break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。 如果存在非空的 case 直穿语句，主体里 必须 有类似 // no break 的注释。 switch ($expr) { case 0: echo ‘First case, with a break‘; break; case 1: echo ‘Second case, which falls through‘; // no break case 2: case 3: case 4: echo ‘Third case, return instead of break‘; return; default: echo ‘Default case‘; break; } c． 在for和wiile的循环使用中，要警惕continue、break的使用，避免产生类似goto的问题； 一个规范的 while 语句应该如下所示，注意其「括号」、「空格」以及「花括号」的位置。 while ($expr) { // 结构体 } 标准的 do while 语句如下所示，同样的，注意其「括号」、「空格」以及「花括号」的位置。 do { // 结构体 } while ($expr); PHP 类的构造函数 如果要在类里面编写构造函数，必须遵循以下规则： a．不能在构造函数中有太多实际操作，顶多用来初始化一些值和变量； b．不能在构造函数中因为使用操作而返回false或者错误，因为在声明和实例化一个对象的时候，是不能返回错误的； PHP 语句断行, 每行控制在80个字符以内 在代码书写中，遵循以下原则： a． 尽量保证程序语句一行就是一句，而不要让一行语句太长产生折行； b． 尽量不要使一行的代码太长，一般控制在80个字符以内； c． 如果一行代码太长，请使用类似 .= 的方式断行书写； d． 对于执行数据库的sql语句操作，尽量不要在函数内写sql语句，而先用变量定义sql语句，然后在执行操作的函数中调用定义的变量； 例子： $sql = "SELECT username,password,address,age,postcode FROM test_t "; $sql .= " WHERE username=‘aaa‘"; $res = mysql_query($sql); PHP 不要不可思议的数字 一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如： if (22 == $foo) { start_thermo_nuclear_war(); } else if (19 == $foo){ refund_lotso_money(); } else{ cry_cause_im_lost(); } 你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如： define("PRESIDENT_WENT_CRAZY", "22"); define("WE_GOOFED", "19"); define("THEY_DIDNT_PAY", "16"); if ( PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); } else if (WE_GOOFED == $foo) { refund_lotso_money(); } else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); } else{ happy_days_i_know_why_im_here(); } PHP true/false和0/1判断 遵循以下规则： a． 不能使用0/1代替true/false，在PHP中，这是不相等的； b． 不要使用非零的表达式、变量或者方法直接进行true/false判断，而必须使用严格的完整true/false判断； 如：不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check()) PHP 避免嵌入式赋值 在程序中避免下面例子中的嵌入式赋值： 不使用这样的方式： while ($a != ($c = getchar())){ process the character } PHP 错误返回检测规则 检查所有的系统调用的错误信息，除非你要忽略错误。 为每条系统错误消息定义好系统错误文本，并记录错误LOG。 PHP程序注释 每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR提供的注释要求，为今后利用phpdoc生成php文档做准备。程序注释的原则如下： a．注释中除了文件头的注释块外，其他地方都不使用//注释，而使用/* */的注释； b．注释内容必须写在被注释对象的前面，不写在一行或者后面； PHP程序头注释块 每个程序头部必须有统一的注释块，规则如下： 一。必须包含本程序的描述； b。必须包含作者； c。必须包含书写日期； d。必须包含版本信息； e。必须包含项目名称； f。必须包含文件的名称； g。重要的使用说明，如类的调用方法，注意事项等；参考示例 如下：
// // + ----------------------------------------------- ---------- + // | PHP版本4.0 | // + ----------------------------------------------- ---------- + // | 版权所有（c）1997-2001 The PHP Group |版权所有。 // + ----------------------------------------------- ---------- + // | 此源文件受PHP许可的约束， // | 与该packafile许可捆绑在一起的是| // | 可以通过以下网址访问： // | http://www.php.net/license/2_02.txt。| // | 如果您没有收到的副本，并且无法| // | 通过万维网获取它，在 // | license@php.net，因此我们可以立即向您发送邮件。| // + ----------------------------------------------- ---------- + // | 作者：**** // | Tomas VVCox // | | // + ----------------------------------------------- ---------- + // // $ Id：Common.php，v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $ PHP类的注释 Author: // 作者 Version : // 版本 Date: // 日期 Description: // 模块描述 Function List: // 主要函数及其功能 History: // 历史修改记录 /** * @purpose:产品投标查询 * @date: 2017-4-21 * @param $id * @param Request $request * @param Comment $commentModel * @throws \Exception * @return mixed class Database { public function article($id, Request $request, Comment $commentModel){} } PHP函数和方法的注释 函数和方法的注释写在函数和方法的前面，采用类似下面例子的规则： /** * @Purpose: * 执行一次查询 * @Method Name: Query() * @Param: string $queryStr SQL查询字符串 * @Param: string $username 用户名 * @Date: 2017-4-21 * @Author: Michael Lee * @Return: mixed 查询返回值（结果集对象） */ function（$queryStr,$username） {……} PHP变量或者语句注释 程序中变量或者语句的注释遵循以下原则： a． 写在变量或者语句的前面一行，而不写在同行或者后面； b． 注释采用/* */的方式； c． 每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。 d． 注释完整规范。 e． 把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。 例子： /** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string * @Date: 2017-4-21 */ var db_user_name; 《PHP PSR 标准规范》 标签：一起 邮件 条件判断 file 书写规则 password php attribute 静态变量 原文地址：https://www.cnblogs.com/laowangbk/p/13344335.html
* @author: xiaohuihui 88787@qq.com
上一篇：Netty小案例