基本代码规范本篇规范制定了代码基本元素的相关标准,
以确保共享的php代码间具有较高程度的技术互通性。
关键词 “必须”(must)、“一定不可/一定不能”(must not)、“需要”(required)、
“将会”(shall)、“不会”(shall not)、“应该”(should)、“不该”(should not)、
“推荐”(recommended)、“可以”(may)和”可选“(optional)的详细描述可参见 [rfc 2119][] 。
概览
php代码文件必须以 一定不可使用其它自定义标签。
2.2. 字符编码php代码必须且只可使用不带bom的utf-8编码。
2.3. 从属效应(副作用)一份php文件中应该要不就只定义新的声明,如类、函数或常量等不产生从属效应的操作,要不就只有会产生从属效应的逻辑操作,但不该同时具有两者。
“从属效应”(side effects)一词的意思是,仅仅通过包含文件,不直接声明类、
函数和常量等,而执行的逻辑操作。
“从属效应”包含却不仅限于:生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。
以下是一个反例,一份包含声明以及产生从属效应的代码:
复制代码
下面是一个范例,一份只包含声明不产生从属效应的代码:
复制代码
命名空间和类
命名空间以及类的命名必须遵循 [psr-0][].
根据规范,每个类都独立为一个文件,且命名空间至少有一个层次:顶级的组织名称(vendor name)。
类的命名必须 遵循 studlycaps 大写开头的驼峰命名规范。
php 5.3及以后版本的代码必须使用正式的命名空间。
例如:
复制代码
5.2.x及之前的版本应该使用伪命名空间的写法,约定俗成使用顶级的组织名称(vendor name)如 vendor_ 为类前缀。
复制代码
类的常量、属性和方法
此处的“类”指代所有的类、接口以及可复用代码块(traits)
4.1. 常量类的常量中所有字母都必须大写,词间以下划线分隔。
参照以下代码:
复制代码
4.2. 属性类的属性命名可以遵循 大写开头的驼峰式 ($studlycaps)、小写开头的驼峰式 ($camelcase) 又或者是 下划线分隔式 ($under_score),本规范不做强制要求,但无论遵循哪种命名方式,都应该在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
4.3. 方法方法名称必须符合 camelcase() 式的小写开头驼峰命名规范。
转自github(pizzaliu)
php, psr