CodeIgniter PHP框架学习之五(开发规范)

开发规范
1、文件格式:文件应该采用无BOM的UTF-8编码,并用LF作为换行符。
2、PHP闭合标签:所有的php文件应该省略这个php闭合标签“?>”,并插入一段注释来标明这是文件的底部并定位这个文件在这个应用的相对路径。这样有利于你确定这个文件已经结束而不是被删节的。比如:
/* End of file myfile.php */
/* Location: ./system/modules/mymodule/myfile.php */
3、类和方法(函数)的命名规则:类名的首字母应该大写,构造方法的名称要与类名相同。如果名称由多个词组成,词之间要用下划线分隔,不要使用骆驼命名法。类中所有其他方法的名称应该完全小写并且名称能明确指明这个函数的用途,最好用动词开头。尽量避免过长和冗余的名称。
4、变量命名:变量名应该只包含小写字母和数字(不能以数字开头),用下划线分隔,并且能适当地指明变量的用途和内容。那些短的、无意义的变量名应该只作为迭代器用在for()循环里。
5、注释:
文档块注释:
/**
* Super Class
*
* @package Package Name
* @subpackage Subpackage
* @category Category
* @author Author Name
* @link http://example.com
*/
行注释:使用行注释时,在大的注释块和代码间留一个空行。
5、常量:常量命名除了要全部用大写外,其他的规则都和变量相同。
6、特殊变量:TRUE, FALSE, 和 NULL关键字应该全部大写。
7、逻辑操作符: 在||、&&、!的前后都要加一个空格。
无论什么时候,在声明有参数的函数时,要给参数设定默认值。

Leave a Reply