PHP编码与MySQL数据库开发规范.docx

北京大学软件与微电子学院 .
文档编号：CS-0001
北京大学软件与微电子学院
.
PHP 编码与MySQL 数据库开发规范
表示标题的图片我们取名： title
例： 、 、 、 、、 、 、 。
PHP 文件命名
命名规则：一般用一个能够描述该文件功能的“名词”命名，如果不能描述清楚，则用“动词”+“_”+“名词”的方式来命名。如一般系统用户注册，就用“”作为 主文件的用户名，如果教师注册、学生注册的页面文件不一样，则教师注册页面使用“”命名，学生注册的页面使用“”命名。
程序代码编程规范
命名规则
变量/函数一般命名规则
一般不使用'_'分隔单词，多个单词组成的标识名通过单词首字母大写分隔。如“$strName”
北京大学软件与微电子学院 .
变量命名
所有字母都使用小写，如由多个单词组成，首字母后的单词首字母大写。例：$strUserName;
变量类型前缀
原则上定义的变量应加上类型前缀，各类型对应前缀如下表：
子类型
Integer Float Double String
Integer Array Float
Double String Array
Object
前缀
i f d
str iArr fArr dArr strArr
O
示例
iQuantity fNumber dTolerance strFirstName iArrNumber fArrPrice dArrPrice strArrCustom
oCurrent
特例：
其中，只有在for 循环或while 循环中表示计数时，才可直接使用i、j、k 等字母命名变量。
命名SQL 变量，需统一命名，规则如下： 查询数据SQL：$querySql
插入数据SQL：$insertSql 更新数据SQL：$updateSql 删除数据SQL：$deleteSql
全局变量命名
全局变量命名应使用前缀'global_'。原则上全局变量限制使用，一个模块里应不超过 3
个，使用不超过 5 次。
例：global $global_strLog;
建议不使用全局变量。
全局常量命名
全局常量使用'_'分隔每个单词，每个单词均大写。例：$DB_LOGIN_NAME = 'root';
北京大学软件与微电子学院 .
静态变量命名
静态变量命名应使用前缀'static_' 例：static $static_Status = 0;
引用变量和函数返回引用命名
引用变量命名应使用'ref_'前缀，
例：function doSomething (&$ref_Status) {}; function &ref_Status ( ) {};
临时变量命名
临时变量命名应使用前缀'tmp_type'。例：$tmp_objResult;
函数/方法的命名
函数和方法命名应第一个单词全部小写，后面每个单词第一个字母大写，其它字母小写， 采用“动作+名词”。
常用的一些前缀名：
is - 含义为问一个关于某样事物的问题。无论何时，当人们看到 Is 就会知道这是一个问题。
get - 含义为取得一个数值。set - 含义为设定一个数值。例如：isHitRetryLimit
类命名
名字的首字母使用大写，其他的字母均使用小写。不使用下划线('_')
派生类的命名只与它自身有关，与其父类名称无关。例：class NameOneTwo
类库命名
目前为避免不同厂商和团体类库间的类名冲突，命名空间正在越来越广泛的被采用。当尚未采用命名空间的时候，为了避免类名冲突，可在类名前加上独特的前缀，两个字符一般就可以了。
John Johnson 的数据结构类库可以用Jj 做为前缀，如下：
class JjLinkList
{
}
北京大学软件与微电子学院 .
类的成员变量命名
类的成员变量命名应该以'm_'为前缀。例：
cl