《PHP》课件2-6 PHP的编码规范.pptx

本节主要内容

什么是编码规范

PHP的编码规范

什么是编码规范

编码规范就是融合开发人员长时间积累下来的经验，形成了一种良好统一的编程风格，这种良好统一的风格会在团队开发或二次开发时起到事半功倍的效果。

遵守代码规范的好处如下：

编码规范是团队开发成员的基本要求。

开发人员可以了解任何代码，理清程序的状况。

提高程序的可读性，有利于相关设计人员的交流，提高软件质量。

防止新接触PHP的人出于节省时间的需要，自创一套风格并养成终生的习惯。

有助于程序的维护，降低软件的成本。

有利于团队管理，突显团队后备资源的可用性。

PHP编码规范

代码的书写规范

注释规范

代码的书写规范

缩进

大括号{}

所有的两元运算符号，都应该前后使用空格进行。

命名的规范

if($expre)

{

……

}

if($expre){

……

}

命名的规范

常量的命名规范：常量的命名应该全部使用大写字母，单词之间用下划线“_”分割。例如define(‘DEFAULT_NUM_AVE’,90);

变量的命名规范：变量统一使用小驼峰，即第一个单词全部小写，其后每个单词首字母大写。如：$workYears。

类命名规范：类名称统一使用大驼峰（即每个单词都首字母大写）。如Cookie、SuperMan、BigClassObject类。

函数命名规范：函数命名规范和变量一样，统一使用小驼峰命名。

类文件命名规范：PHP类文件命名时都是以class.php为后缀，文件名和类名相同。例如，类名为DBMySql，则类文件命名为DbMySql.class.php。

注释规范

程序注释：

单行代码按照习惯写在代码尾部；

大段注释采用/**/的方式，通常为文件或函数的顶部，代码内部使用//；

注释不宜太多；

代码注释应该描述为什么而不是做什么，给代码阅读者提供最主要的信息。

注释规范

文件注释：

文件注释一般放在文件的顶部，包括本程序的描述、作者、项目名称、文件名称、时间日期、版本信息、重要的使用说明（类的调用，注意事项等）。

版本更改要修改版本号，并加上modify注释。

注释规范

类和接口注释：按照一般的习惯，一个文件只包含一个类。

注释规范

方法和函数注释：方法和函数的注释写在前面，通常需要表明信息的主要可见性、参数类型和返回值类型。如下例所示：

/**

*连接数据库

*@paramstring$dbhost数据库服务器地址

*@paramstring$dbuser数据库用户名

*@paramstring$dbpwd数据库密码

*/

Thankyou!