4.3.4 变量或者语句注释
程序中变量或者语句的注释遵循以下原则:
a. 写在变量或者语句的前面一行,而不写在同行或者后面;
b. 注释采用/* */的方式;
c. 每个函数前面要包含一个注释块。内容包括函数功能简述,输入/输出参数,预期的返回值,出错代码定义。
d. 注释完整规范。
e. 把已经注释掉的代码删除,或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
f.
例子:
/**
* @Purpose:
* 数据库连接用户名
* @Attribute/Variable Name: db_user_name
* @Type: string
*/
var db_user_name;
4.4 其他规范(建议)
4.4.1 php代码标记
所有的php程序代码块标记均使用
4.4.2 程序文件名、目录名
程序文件名和目录名命名均采用有意义的英文方式命名,不使用拼音或无意义的字母,同时均必须使用小写字母,多个词间使用_间隔。
4.4.3 PHP项目通常的文件目录结构
建议在开发规范的独立的PHP项目时,使用规范的文件目录结构,这有助于提高项目的逻辑结构合理性,对应扩展和合作,以及团队开发均有好处。
一个完整独立的PHP项目通常的文件和目录结构如下:
/ 项目根目录
/manage 后台管理文件存放目录
/css css文件存放目录
/doc 存放项目文档
/images 所有图片文件存放路径(在里面根据目录结构设立子目录)
/scripts 客户端js脚本存放目录
/tpl 网站所有html的模版文件存放目录
/error.php 错误处理文件(可以定义到apache的错误处理中)
以上目录结构是通常的目录结构,根据具体应用的具体情况,可以考虑不用完全遵循,但是尽量做到规范化。
4.4.4 PHP和HTML代码的分离问题
对性能要求不是很高的项目和应用,我们建议不采用PHP和HTML代码直接混排的方式书写代码,而采用PHP和HTML代码分离的方式,即采用模版的方式处理,这样一方面对程序逻辑结构更加清晰有利,也有助于开发过程中人员的分工安排,同时还对日后项目的页面升级该版提供更多便利。
对于一些特殊情况,比如对性能要求很高的应用,可以不采用模版方式。
4.4.5 PHP项目开发中的程序逻辑结构
对于PHP项目开发,尽量采用OOP的思想开发,尤其在PHP5以后,对于面向对象的开发功能大大提高。
在PHP项目中,我们建议将独立的功能模块尽量写成函数调用,对应一整块业务逻辑,我们建议封装成类,既可以提高代码可读性,也可以提高代码重用性。比如,我们通常将对数据库的接口封装成数据库类,有利于平台的移植。
重复的代码要做成公共的库。(除了我们在plug-in产品上遇到的情况,该产品系列有多个相类似的产品,为了尽可能地减少安装包尺寸,不适合将这些产品共用的所有函数做成公共的库)
5 特定环境下PHP编码特殊规范
5.1 变量定义
XXX环境下的php代码编写要求所有的变量均需要先申明后使用,否则会有错误信息,对于数组,在使用一个不确定的key时,比如先进行isset()的判断,然后再使用;比如下面的代码:
$array = array();
$var = isset($array[3]) ? $array[3] : “”;
5.2 引用的使用
引用在程序中使用比较多,为了公用同一个内存,而不需要另外进行复制,XXX环境下的引用使用时,需要注意下面的情况;
在对函数的输入参数中使用引用时,不能在调用的时候在输入参数前加&来引用,而直接使用该变量即可,同时必须在函数定义的时候说明输入参数来自引用,比如下面的代码:
$a = 1;
function ab(&$var)
{
$var ++;
return $var;
}
$b = ab($a) // 注意,此处不能使用 $b = ab(&$a)的方式;
echo $b.”/n”;
echo $a.”/n”;
此时 $a和$b都是2;