编码thinksns v3智士软件.pdfVIP

1文档编写目的不简介4

2编码规范4

2.1文件格式4

2.2命名约定5

2.3编码风格8

Page3

1文档编写目的与简介

本文描述系统编码规范，为开发及二次开发人员提供依据和参考。

2编码规范

2.1文件格式

1.对于只含有php代码的文件，在文件结尾处忽略掉?。这是为了防止多余的空格戒

者其它字符影响到代码。

例如：

?php

$foo=foo;

2.缩进应该能够反映出代码的逻辑结果，尽量使用四个空格，使用制表符TAB，因为这样能

够保证有跨客户端编程器软件的灵活性。

例如：

if(1==$x){

$indented_code=1;

if(1==$new_line){

$more_indented_code=1;

}

}

3.变量赋值必须保持相等间距和排列。

例如：

Page4

$variable=demo;

$var=demo2;

4.每行代码长度应控制在80个字符以内，最长丌超过120个字符。因为linux读入文件一般以80

列为单位，就是说如果一行代码超过80个字符，那么系统将为此付出额外操作指令。这个虽然看

起来是小问题，但是对于追求完美的程序员来说也是值得注意并遵守的规范。

5.每行结尾丌允许有多余的空格。

2.2命名约定

1.类文件都是以“.class.php“为后缀，且类文件名只允许字母，使用驼峰法命名，并且首字母大

写，例如：DbMysql.class.php。

2.配置和函数等其他类库文件乊外的文件一般是分别以“.inc.php“和”.php“为后缀，且文件

名命名使用小写字母和下划线的方式，多个单词乊间以下划线分隔，例如

config.inc.php，common.php，install_function.php。

3.确保文件名和调用大小写一致，是由于在类Unix系统上面，对大小写是敏感的。

4.类名和文件名一致（包括上面说的大小写一致），且类名只允许字母，例如UserAction类的文

件命名是UserAction.class.php，InfoModel类的文件名是InfoModel.class.php。

5.控制器类以Action为后缀，例如UserAction、InfoAction，模型类以Model为后缀，例如

UserModel、InfoModel，其他类也分别以相应分类为后缀，例如Service、Widget。

6.方法名只允许由字母组成，下划线是丌允许的，首字母要小写，其后每个单词首字母要大写，

即所谓的“驼峰法命名”规则，且越详细越好，应该能够描述清楚该方法的功能，例如switchModel、

findPage。

7.属性名只允许由小写字母和下划线组成，且建议用描述性的变量名，越详细越好。

Page5

8.对于对象成员的，须始终使用“get”和“set”方法。例如：

classFoo

{

protected$test_obj;

publicfunctiongetTestObj()

{

return$this-test_obj;

}

publicfunctionsetTestObj($test_obj)

{

$this-test_obj=$test_obj;

}

}

9.当类成员