代码文档规范 PHP开发网站代码编写规范

PHP开发网站代码编写规范  

一 变量命名

　　a) 所有字母都使用小写

　　b) 首字母根据变量值类型指定

　　i 整数i

　　ii 浮点数f

　　iii 字符串s

　　iv 布尔值b

　　v 数组a

　　vi 对象o

　　vii 资源r

　　viii 混合类型m

　　c) 使用 _ 作为每一个词的分界

　　例如

　　$i_age_max = ;

　　$f_price = ;

　　$s_name = harry ;

　　$b_flag = true;

　　$a_price = array();

　　$o_object = new class();

　　$r_file = fopen();

　　$m_var = array_bine($a_name $a_flag);

二 类命名

　　a) 使用大写字母作为词的分隔 其他的字母均使用小写 即驼峰格式

　　b) 名字的首字母使用大写

　　c) 不要使用下划线( _ )

　　d) interface接口最好使用大写字母I 并以Interface结尾

　　例如

　　class NameOneTwo

　　class Name

　　interface IExampleInterface ()

三 方法命名

　　a) 使用大写字母作为词的分隔 其他的字母均使用小写

　　b) 名字的首字母使用大写 声明为 private 或 protected 的 使用 _ 为前缀

　　c) 不要使用下划线( _ )

　　d) (与类命名一致的规则)

　　e) 对象的访问器总是以 get 或 set 为前缀 当使用设计模式如 单态模式（singleton）或工厂模式（factory） 方法的名字应当包含模式的名字 这样容易从名字识别设计模式

　　例如

　　class NameOneTwo{

　　public function DoIt() {};

　　protect function _HandleError() {};

　　private function _SayHello() {};

　　}

四 类属性命名

　　a) 属性名前缀应以属性值类型指定（具体参照变量命名规则）

　　b) 前缀后采用与类命名一致的规则

　　c) 私有属性采用 _ 为前缀

　　例如

　　class NameOneTwo {

　　public function VarAbc() {};

　　public function ErrorNumber() {};

　　public $iAge;

　　private $_iAge;

　　}

五 方法中参数命名

　　a) 参照类属性命名

　　例如

　　class NameOneTwo {

　　public function VarAbc($sMsg) {};

　　}

六 全局变量

　　a) 全局变量应该带前缀 g

　　b) 其余参照变量命名规则

　　例如

　　global $gi_Age;

　　global $ga_Price

七 定义命名/全局常量

　　a) 全局常量使用 _ 分割每个单词

　　b) 所有字母使用大写

　　例如

　　define( E_ERROR_MISSING_PARA );

八 函数

　　a) 所有的字母采用小写 使用 _ 分割每个单词

　　例如

　　function some_bloody_function(){

　　}

九 大括号{}规则

　　a) 将大括号放置关键词下方的同列处或同行 推荐放到同行

　　例如

　　function some_bloody_function() {

　　}

　　if (true) {

　　// code

　　}

十 缩进/制表符规则

　　a) 使用制表符缩进

　　例如

　　function some_bloody_function() {

　　if (true) {

　　//code

　　}

　　}