PHP 项目开发规范文档.docx

PHP 项目开发规范文档
文件及文件目录规范
命名规范
文件名以全部小写的英文字母组成, 建议使用英文单词, 必要时使用复数; 多个单词之间以下划线隔开, 类文件建议以类的名字的小写命名;则这不仅仅是 PHP 文件，包括整个项目的PHP 项目开发规范文档
文件及文件目录规范
命名规范
文件名以全部小写的英文字母组成, 建议使用英文单词, 必要时使用复数; 多个单词之间以下划线隔开, 类文件建议以类的名字的小写命名;则这不仅仅是 PHP 文件，包括整个项目的文件.
例:
一般常见文件:
, , ,
类文件
=> Class Accounts {……};
目录结构规范
目录的命名同文件名一样,英文字母,全部小写. 例:
/lib 常用 PHP 文件,库文件
/images 页面上使用的背景图或图标文件存在目录
/js 页面上使用的js 文件
/languages 语言包文件
/templates 模板文件存在目录
/cache 站点数据存储目录, 比如像日志, 附件, 配置文件等,均可以创建子目录存放在这该目录下;
变量规范
变量命名
form 域命名及 URL 参数名命名
考虑到 PHP 的数组下标(key)的应用是区分大小写的, 所以强制全部采用小写字母组成, 多词组成时可以用减号隔开.
变量命名
$ + 变量类型_变量命名 作为规则, 变量命名采用英文单词,多词组成时用下划线连接;变量类型不一定强制! 必须用小写. 例: $table_name
PHP 常用的类型:
String str 例: $str_username, $str_password,$password Integer int 例: $int_id,$id
Float flt 例: $flt_money,$money Double dbl 例: $dbl_pie,$pie Boolean bln 例: $bln_isset
Array arr 例: $arr_data,$data PHP 用于全局变量类型:
defined( 'IN_OLCMS' )
$Global 即 全局变量的配置变量 ,全局变量首字母用大写PHP 常量首全部用大写
变量的初始化
PHP 本身并没有对初始化变量的名字. 所以我们能做的就是给一个未使用的赋一个空值. 例:
$arrData = array();
$intQuality = 0;
函数与类规范
函数的命名
下划线连接的组合规则, 例 init() ， list_category()
类的命名规范
类的命名
类的命名也采用首字母大写的组合规则. 例 Class Users {…….}
类成员的命名
类的成员函数也采用小写的组合规则, 但为了避免函数名过长,可以灵活结合类的名字命名例如 Users::delete($uid) 即用户类的成员函数用户删除函数
语法规范
表达式、流程控制语句中，! 例如:以下空格以红