PHP与数据库代码开发规范

 

1 、 PHP 中对各类变量内容的命名规范

 

（ 1 ）目录命名、文件命名、局部变量命名：

使用英文名词、动词，以下划线作为单词的分隔，所有字母均使用小写

目录： upload 、 templates 、 install 、 manage ……
文件： index.php 、 register.php  、 config.php ……
变量： $user , $pay_time , $pay_del_cont ……

（ 2 ）全局常量命名：
使用英文名词、动词，所有字母都使用大写，以下划线分隔每个单词

define( 'WEBSITE_NAME', ' 名称 ' );

define( 'WEBSITE_URL',  ' 地址 ' )

（ 3 ）数组变量命名：

英文名词、动词，以下划线作为分隔，所有字母均使用小写以 array 结束

$scope_array  = array();

$book_id_array = array();

（ 4 ）对象变量命名：
英文名词、动词，以下划线作为分隔 , 可以完整采用类名或是简化类名，但是必须明确知 道是什么类，所有字母均使用小写，在变量后加上 _obj

$user_obj   = new userAccount();

$pay_obj   = new payOrder();

（ 5 ）类的命名：
使用英文名词，以大写字母作为词的分隔，其他的字母均使用小写，名词的首个字母使 用小写，不使用下划线

class userAccount{ …… }

（ 6 ）方法命名：

使用英文名词、动词，以下划线作为单词的分隔，所有字母均使用小写

class user Account {

 public $name_ account = ‘’ ;

 function is_ account _ok(){

  ...

 }

 function add_ account (){

  ...

 }

}

2 、 PHP 中函数、符号、运算写作规范

（ 1 ） if 语句大括号 {} 规则：

将大括号放置在关键词后方

使用 IF 语句尽量使用大括号

2 、 PHP 中函数、符号、运算写作规范

html 的 form 表单各个元素名称与数据库字段尽量保持一致。

不要采用缺省方法测试非零值，必须显式测试，例：

if ( $name_pay_into != false ){

 ...

}else{

 ...

}

* 尽可能使用单引号 '' 而不是双引号 "", 在需要加入变量或是写 sql 语句除外。

*php 文件中尽可能不出现 html 语句，如果实在无法解决尽量少用，考虑到模板的兼容性，

html 文件中尽可能避免出现 php 语句。
* 通常每个方法只执行一项逻辑动作事务，所以对它们的命名应该清楚的说明它们是做什么的：
用 email_error_check() 代替 error_check() 。

请注意命名不要与系统方法冲突。

3 、 PHP 中各类注释规范

/**

*  分页预处理函数

*  sql SQL 语句

*  page 当前页数

*  limit 每页显示的数量

*  maxs 查询总数

*/

function limit($sql,$page='0',$limit=10,$maxs=''){ }

// 用户检测

if( $check_obj->username( $username ) == true ){ … }

$user_name = $_GET[user];  // 获取用户信息