《PEAR 编写规范》由会员分享，可在线阅读，更多相关《PEAR 编写规范（10页珍藏版）》请在金锄头文库上搜索。
1、PEAR 编写规范目录PEAR 编写规范 .1缩进 .1控制结构 .2函数调用 .3函数定义 .4注释 .5包含代码 .5PHP 代码标记 .6使用 CVS.7命名约定 .9Classes.9函数和方法 .9常数 .10全局变量 .10预定义的值 true、false 和 null .10缩进缩进使用 4 个空格，而不是 tab。如果你使用 Emacs 编辑 PEAR 代码，你应该设置 indent-tabs-mode为 nil。下面是一个 mode hook 的示例，用于设置Emacs 符合缩进标准（你必须确保在编辑 PHP 文件时，这些设置发生作用）：(defun php-mode-hoo
2、k ()(setq tab-width 4c-basic-offset 4c-hanging-comment-ender-p nilindent-tabs-mode(not (and (string-match /(PEAR|pear)/ (buffer-file-name)(string-match .php$ (buffer-file-name)这里是同等效果的 vim 规则：set expandtabset shiftwidth=4set softtabstop=4set tabstop=4-控制结构控制结构包含 if、for、while、switch 等。这里有一个 if 语句的示例和
3、一个switch 语句的示例：if 语句的示例：if (condition1)| (condition2) action1; elseif (condition3) & (condition4) action2; else defaultaction;?switch 语句的示例：switch (condition) case 1:action1;break;case 2:action2;break;default: defaultaction;break;?控制语句应该在控制关键词和开始的圆括号之间应该有一个空格，以此和函数调用进行区别。强烈建议你总是使用花括号将控制结构各部分标识出来。即使是
4、在技术上可以不使用花括号的地方。这可以增加代码的可读性，同时避免在结构部分增加新行后引入逻辑上的错误。原始代码：if (condition)return true;elsereturn false;修改后的代码：if (condition)do something; / 出现逻辑错误return true;elsereturn false;正确的做法：if (condition) do something;return true; else return false;-函数调用调用函数时，函数名和开始的括号之间不应该有空白字符。参数和开始及结束的括号之间不应有空格。而除第一个参数外，其他参数都
5、应该用一个空格分隔。这里有一个示例：$var = foo($bar, $baz, $quux);?像上面的示例代码，赋值运算等号两边都应该使用一个空格。如果是相关的赋值运算，应该采用下面的形式以提供更好的可读性：$short = foo($bar);$long_variable = foo($baz);?-函数定义按照“one true brace”约定声明函数：function fooFunction($arg1, $arg2 = )if (condition) statement;return $val;?“one true brace”约定就是开始的花括号单独占一行，而不是跟在其他语句后
6、面。具有默认值的参数应该位于参数列表的后面（事实上 PHP 语言定义也要求如此） 。如果适合，函数应该总是返回一个有意义的值。这里有一个稍微长一点的示例：function connect(&$dsn, $persistent = false)if (is_array($dsn) $dsninfo = &$dsn; else $dsninfo = DB:parseDSN($dsn);if (!$dsninfo |!$dsninfophptype) return $this-raiseError();return true;?-注释类型（class ）的联机文档应该符合 PHPDoc（类似于 Ja
7、vaDoc）的约定。更多关于 PHPDoc 的信息可以访问 http:/www.phpdoc.de/ 获得。此外，强烈鼓励使用非文档注释。一般性规则是对于那些容易忘记作用的代码添加简短的介绍性注释。推荐使用 C 样式的注释（ /* */）和标准 C+ 注释（/)，而不应该使用 Perl/shell 样式的注释（#） 。-包含代码无论在什么地方无条件包含一个类型文件，应该使用 require_once()。如果有条件的包含一个类型文件（例如使用工厂方法） ，应该使用 include_once()。使用两者中的任何一个都能够确保类型文件只包含一次。它们共享一个文件列表，因此你不需要担心混淆他们 一个文件使用 require_once() 包含后不会在 include_once() 中再一次被包含。备注：include_once() 和 require_once() 是一个声明，而不是函数。你不需要使用圆括号将文件名扩起来（不过使用括号也不会出现错误） 。-PHP 代码标记总是使用 来界定 PHP 代码，而不要使用 速记方式。这是为了符合PEAR 一致性所必须的，同时也是在不同操作系统和不同安装设置环境下移植 PHP 代码所要求的。-头注释块PEAR 发布的所有源代码文件头部都应该包含下面的注释块：/* vim: se
