2009年1月11日星期日

Zend Framework编码标准

这是Zend Framework编码标准的一个精要版本。翻译自“PHP Object-Oriented Solutions”。



    • 命名规则


    • 类名能够反映定义类的文件所在存储位置的文件路径,文件路径用下划线分割。本书实例代码中的所有类都位于Pos目录下,因此文件Validator.php中定义的类叫做Pos_Validator。

    • 仅对目录名或文件名中的单词的首字母进行大写。

    • 为方法和属性所用具有描述性的名字。应该尽可能的使用长名,以帮助理解。名字应以小写字母打头,如果名字由多个单词组成,其后的每个单词都必须以大写字母开头。(骆驼型)

    • 私有(private)和受保护(protected)的属性应以一下划线开头。

    • 只对常数使用大写字母命名,单词之间以下划线分隔。




    • 编码风格


    • 总是使用完整的PHP起始标签(<?php)。

    • 只有PHP代码的文件中应省略PHP关闭标签(?>)关闭标签是可选的,仅仅是表示后面没有PHP代码了(例如,后面还有HTML)。省略关闭标签的好处是可以在使用文件包含的时候,避免多余的空白字符所引发的“header already sent”(文件头已经发出)的错误。

    • 代码缩进量为四个空格。

    • 只要可以,就应该把一行的长度限制在80个字符以内。

    • 对字符串总是使用单引号,除非字符串中含有需要替换的变量或其他引号。

    • 使用但双引号的组合,而避免对引号进行转义。

    • 在连接操作符(.)的两侧都放上一个空格以增加可读性。

    • 在逗号后面加上一个空格以增强可读性。

    • 把关联数组项置于不同的行上,并使用空格让键与值分别对齐。

    • 把类和函数定义的花括号置于单独的行中。

    • 把条件语句的开花括号放在条件的同一行,闭花括号置于单独的行中。

    • 使用PHPDoc格式的注释。



没有评论:

发表评论