PHP编码的规范.pdf

一、文件格式 1. 对于只含有 php 代码的文件，我们将在文件结尾处忽略掉 ? 。这是为了防止多 余的空格或者其它字符影响到代码。 例如： ?ph $foo = foo 2. 缩进应该能够反映出代码的逻辑结果，尽量使用四个空格，禁止使用制表符 TAB ， 因为这样能够保证有跨客户端编程器软件的灵活性。 例如： if (1 == $x) { $indented_code = 1 if (1 == $new_line) { $more_indented_code = 1 3. 变量赋值必须保持相等间距和排列。 例如： $variable = demo $var = demo2 4. 每行代码长度应控制在 80 个字符以内，最长不超过 120 个字符。因为 linux 读入文 件一般以 80 列为单位，就是说如果一行代码超过 80 个字符，那么系统将为此付出额 外操作指令。这个虽然看起来是小问题，但是对于追求完美的程序员来说也是值得注 意并遵守的规范。 5. 每行结尾不允许有多余的空格。 二、命名约定 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. 属性的命名只允许由字母组成，下划线是不允许的，首字母要小写，其后每个单词 首字母要大写，即所谓的 “驼峰法命名”规则，例如 tablePrefix、tableName 。 8. 对于对象成员的访问，我们必须始终使用 “get” 和 “set” 方法。例如： class Foo rotected $_testObj ublic function getTestObj() return $this-_testObj ublic function setTestObj($testObj) $this-testObj = $_testObj 9. 当类成员方法被声明为 private 时，必须分别以双下划线 __为开头；被声明为 protected 时，必须分别以单下划线 _ 为开头；一般情况下的方法不含下划线。例 如 ： class Foo rivate function __example() // ... rotected function _example() // ... ublic function example() // ... 10. 如果我们需要把一些经常使用的方法定义为全局函数，那么应该把它们以静态 (static) 的形式定义在类中。例如： class Think // ... tatic public function autoload($classname) // ... 11. 被声明为 private 的类成员属性必须由双下划线 __ 作为开头；被声明为 protected 的类成员属性必须由下划线 _ 作为开头；而声明为 public 的成员属性则在 任何时候都不允许含有下划线。 12. 函数的命名使用小写字母和下划线的方式，且越详细越好，应该能够描述清楚该函 数的功能，例如 get_client_ip 。 13. 当方法或函数参数不一定需要被赋值的时候，用 null 来代替 false 作为函数参 数的默认值，除非该参数是 bo