PHP 实际应用编码规范

前言：

为了提高工作效率,保证开发的有效性和合理性,并最大程度提高程序代码的可读性和可重复利用性,提高沟通效率,需要一份代码编写规范,本文介绍的规范参考了Zend与PEAR编码规范,并进行了适当的简化和调整,尽量坚持简约易懂.通过代码规范,让大家养成良好的代码编写习惯,并减少代码中的bug.

本规范包括PHP开发时程序编码中的命令规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包括代码、PHP标记、常量命名等方面的规则.

本规范不强制指定和保举某种格式,并就实际开发中个人习惯做了一些调整,仅供大家参考.

1. 文件格式

• 1.1 文件标记

  所有的PHP文件,其代码标记均使用完整PHP标签,不建议使用短标签,对于只含有PHP代码的文件,将在文件结尾忽略“?>”,这是因为防止多余空格或者其他字符影响到代码.

• 1.2 文件和目录命名

  程序文件和目录名均采用有意义的英文命名,不使用拼音或者无意义的字母,只允许出现字母、数字、下划线和中划线字符,同时必须以".php"结尾,多个词间使用驼峰法命名.

• 1.3 文件目录结构

  在开发规范、独立的PHP项目时,使用规范的文件目录结构,有助于提高项目逻辑结构合理性,对于拓展和合作以及团队开发均有好处.

通常一个完整独立的PHP项目的文件目录结构

2. 命名规范

• 2.1 变量命名

PHP中的变量用一个美元符号后面跟变量名表示.变量名区分大小写.一个有效变量名由字母或者下划线开头,后面跟任意数量的字母、数字、下划线.正常的正则表达式为：

[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*

不应该在变量中使用中文等ASCII字符.

1)程序整体

程序整体以驼峰法命名,以小写字母开始,同时命名要有意义

2)PHP全局变量键值

PHP全局变量键值两边都有“_”,中间使用驼峰法命名,如 $_GLOBAL['_beginTime_']

3)普通变量

普通变量整体采用驼峰法,建议在变量前加表示类型的前缀,不确定类型的以大写字母开头,函数参数不确定的类型以大写字母开头,其他地方的变量以小写字母开头,对于一些常见变量,按着约定命名,并避免使用常用关键字或者存在模糊意义的单词,变量应以名词为主,保举：

字符串：$strName

数组：$arrName

对象：$objName

布尔值：$bool

4)函数名

函数名既要有意义,也要尽量缩写,建议采用动词或者动词加形容词的命名方式,如showMsg.

5)类中的属性

类中的属性变量遵循普通变量的命名规则

• 2.2 类及接口命名

在面向对象的代码中,其命名方式有一些特殊,类的命名遵循以下规则：

以大写字母开头：多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写；

类名与类文件坚持一致；

程序中所有类名唯一；

抽象类应以Abstract开头;

接口命名遵循以下规则：

采取和类相同的命名规则,但是在其命名前加i字符,表示接口；

尽量坚持和实现它的类名一致；

• 2.3 数据库命名

  在数据库相关的命名中,一律不出现大写,详细的命名规则如下：

  1)数据库命名遵循以下规范：

  表名均使用小写；

  表名字使用统一的前缀,且前缀不能为空；

  对于多个单词组成的表名,使用“_”间隔.

  2)表字段命名遵循以下规范：

全部使用小写字母命名；

多个单词使用下划线

• 2.4 习惯与约定

  1)缩写

  依照习惯,同时为了减小变量的长度,在不影响可读的前提下,习惯对变量进行缩写,常见于一些函数的参数,如：

  image -> img

  string -> str

  database -> db

  array -> arr

  count -> cnt

  message -> msg

  2)魔术数字

  魔术数字是指直接在程序代码里的具体数值,此类变量尽量定义为常量.

3.注释规范

每个程序必须提供必要的注释,包含文件注释,代码块注释,函数注释等.

• 3.1 程序注释

  程序注释原则如下：

  写在被注释代码前面,而不是很后面,对于单行语句,按着习惯可以把注释放在语句末尾.对于大段注释,使用“/**/”格式,通常在文件和函数注释中使用,而代码内部统一使用“//”注释,因为其写起来简单.注释不宜太多.

• 3.2 文件注释

  文件注释通常放在整个PHP文件头部,其内容包含文件版权,作者,日期,版本号等重要信息.PHP中,可以参照phpdocument规范,便于利用程序自动生成文档.

  文件注释遵循以下规则：

  本程序的描述；

  作者；

  项目名称；

  文件名称；

  日期；

  版本；

  使用说明等；

文件注释说明

• 3.3 办法和函数注释

  办法和函数的注释写在前面,通常需要标明的信息包括函数说明、参数类型和返回值的类型.

4.代码风格

• 4.1 缩进和空格

  在书写代码的时候,必须注意代码的缩进规则：

  使用4个空格作为缩进,而不是tab缩进；

  变量赋值时,等号左右留下空格；

为了最大程度减轻工作量,坚持代码美观,建议使用大型IDE管理代码.

• 4.2 语句断行

  代码书写中应遵循以下原则：

  尽量保证程序语句一行就是一句；

尽量不要使一行代码太长,一般控制在100个字符以内；

如果一行代码太长,请使用 “.=” 的方式断行书写；

执行数据库sql语句操作时,尽量不要在函数内写sql语句,而是先用变量定义sql语句,然后在执行操作的函数中调用定义的变量；

小结：

在开头就提到编码规范的目的是提高工作效率,保证开发的有效性和合理性,并最大程度的提高程序代码的可读性和可重复利用性,减少返工,提高沟通效率.好的代码风格,见代码如见人.

PHP是一门脚本语言,本身就是一门不严谨的语言,所以规范就显得更重要了.

强烈建议使用大型IDE进行代码开发和管理,并使用合适的版本控制软件,保举PhpStorm 和 Git.