《PHP开发编码规范》中包含了PHP代码规范、PHP注释规范等详细的PHP编码规范,主要是为了更好的提高技术部的工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,指定此规范。开发团队根据自己的实际情况,可以对本规范进行补充或裁减。
PHP代码规范
1、概览
u PHP代码文件必须以
u PHP代码文件必须以 不带BOM的 UTF-8 编码;
u PHP代码中应该只定义类、函数、常量等声明,或其他会产生 从属效应 的操作(如:生成文件输出以及修改.ini配置文件等),二者只能选其一;
u 命名空间以及类必须符合 PSR 的自动加载规范:PSR-0 或 PSR-4 中的一个;
u 类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范;
u 类中的常量所有字母都必须大写,单词间用下划线分隔;
u 方法名称必须符合 camelCase 式的小写开头驼峰命名规范。
2、文件
2.1PHP标签
PHP代码必须使用 长标签 或 短输出标签;
一定不可使用其它自定义标签。
2.2字符编码
PHP代码必须且只可使用不带BOM的UTF-8编码。
2.3从属效应
一份PHP文件中应该要不就只定义新的声明,如类、函数或常量等不产生从属效应的操作,要不就只有会产生从属效应的逻辑操作,但不该同时具有两者。
“从属效应”(side effects)一词的意思是,仅仅通过包含文件,不直接声明类、
函数和常量等,而执行的逻辑操作。
“从属效应”包含却不仅限于:生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。
3、命名空间和类
命名空间以及类的命名必须遵循 PSR-0(勘:现在PSR-0已经作废,应遵循PSR-4).
根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须 遵循 StudlyCaps 大写开头的驼峰命名规范。
PHP 5.3及以后版本的代码必须使用正式的命名空间。
例如:
4、类的常量、属性和方法
4.1含义
此处的“类”指代所有的类、接口以及可复用代码块(traits)
4.2常量
类的常量中所有字母都必须大写,词间以下划线分隔。
参照以下代码:
类的属性命名可以遵循 大写开头的驼峰式 ($StudlyCaps)、小写开头的驼峰式 ($camelCase) 又或者是 下划线分隔式 ($under_score),本规范不做强制要求,但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或 整个方法。
4.4方法
方法名称必须符合 camelCase() 式的小写开头驼峰命名规范。
PHP注释规范
1.文件头的注释,介绍文件名,功能以及作者版本号等信息
**
*文件名简单介绍
*
*文件功能。author@version*/
2.函数的注释,函数作用,参数介绍及返回类型
/**
*函数的含义说明
*
*@access public
*@param mixed $arg1参数一的说明*@param mixed $arg2参数二的说明*@param mixed $mixed这是一个混合类型*@return array返回类型
*/
3.类的注释,类名及介绍
/**
*类的介绍
*类的详细介绍(可选。)。*@author
alvin 作者
*@version 1.日 版本号
*/
4.多行注释
/*php注释语法
这是多行注释。*/
5.单行注释
$n = 1e; {/数量n,这是单行注释
总结
PHP是一个应用范围很广的语言,特别是在网络程序开发方面。一般来说PHP大多在服务端运行,透过运行PHP的代码来产生网页提供浏览器读取,此外也可以用来开发命令行脚本程序和用户端的GUI应用程序。PHP可以在许多的不同种的服务器、操作系统、平台上运行,也可以和许多数据库系统结合。使用PHP不需要任何费用,官方组织PHP Group提供了完整的程序源代码,允许用户修改、编译、扩展来使用。
以上就是关PHP开发编码规范的相关内容了,想要了解更多有关php的其它知识也可关注六星社区网站。
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!