如前所述,PEAR按照一定的分类来管理PEAR应用代码库,你的PEAR代码可以组织到其中适当的目录中,其他的人可以方便地检索并分享到你的成果。 PEAR不仅仅是一个代码仓库,它同时也是一个标准,使用这个标准来书写你的PHP代码,将会增强你的程序的可读性,复用性,减少出错的几率。 PEAR通过提供2个类为你搭建了一个框架,实现了诸如析构函数,错误捕获功能,你通过继承就可以使用这些功能。 PEAR的编码规则包括缩进规则,控制结构,函数调用,函数定义,注释,包含代码,PHP标记,文件头的注释块,CVS标记,URL样例,常量的命名这11方面。下面简要地介绍一下: 不过你象我一样喜欢用(X)Emacs编辑PHP文件,我强烈推荐你安装PHP-MODE,这样当你编写PEAR代码的时候,它会自动调整你的缩排风格,当然PHP-MODE还有许多很优秀的特性,你可以从资源列表中的地方下载最新版的PHP-MODE。 控制结构: 关于注释: 包含代码: PHP代码标记: ファイル ヘッダーのコメント ステートメント:
class your_class_name extends PEAR{ } Destructor
缩进规则:
PEAR中需要使用4个空格来缩排代码,并且不使用TAB。如果你使用VIM,将下列设置放入你的~/.vimrc中:set expandtab
set shiftwidth=4
set tabstop=4
如果,你使用Emacs/XEmacs,需要把indent-tabs-mode 设置成nil。
这里所说的控制结构包括: if for while switch 等。对于控制结构,在关键字(如if for ..)后面要空一个格,然后再跟控制的圆括号,这样,不至于和函数调用混淆,此外,你应该尽量完整的使用花括号{},即使从语法上来说是可选的。这样可以防止你以后需添加新的代码行时产生逻辑上的疑惑或者错误。这里是一个样例:if ((条件1) && (条件2)) {
语句1;
}esleif ((条件3) || (条件4)) {
语句2;
}else {
语句3;
}
函数调用:
对于函数调用,函数名和左括号( 之间不应该有空格,对于函数参数,在分隔的逗号和下一个参数之间要有相同的空格分离,最后一个参数和右括号之间不能有空格。下面是一个标准的函数调用;$result = foo($param1, $param2, $param3);
不规范的写法:
$result=foo ($param1,$param2,$param3);
$result=foo( $param1,$param2, $param3 );
此外,如果要将函数的返回结果赋值,那么在等号和所赋值的变量之间要有空格,同时,如果是一系列相关的赋值语句,你添加适当的空格,使它们对齐,就象这样:$result1 = $foo($param1, $param2, $param3);
$var2 = $foo($param3);
$var3 = $foo($param4, $param5);
函数定义:
函数定义遵循"one true brace"习俗:function connect(&$dsn, $persistent = false){
if (is_array($dsn)) {
$dsninfo = &&dsn;
} else {
$dsninfo = DB::parseDSN($dsn);
}
if (!$dsninfo || !$dsninfo[phptype]) {
return $this->raiseError();
}
return true;
}
如上所示,可选参数要在参数表的末端,并且总是尽量返回有意义的函数值。
对于类的在线文档,应该能够被PHPDoc转换,就象JavaDoc那样。PHPDoc也是一个PEAR的应用程序,更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档,建议你应该使用非文档性质的注释来诠释你的代码,当你看到一段代码时想:哦,我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释,这样防止你会忘记它们是如何工作的。对于注释的形式,C的 /* */和C++的//都不错,不过,不要使用Perl或者shell的#注释方式。
无论什么时候,当你需要无条件包含进一个class文件,你必须使用requre_once;当你需要条件包含进一个class文件,你必须使用 include_once;这样可以保证你要包含的文件只会包含一次,并且这2个语句共用同一个文件列表,所以你无须担心二者会混淆,一旦 require_once 包含了一个文件,include_once不会再重复包含相同的文件,反之亦然。
任何时候都要使用定义你的php代码,而不要简单地使用,这样可以保证PEAR的兼容性,也利于跨平台的移植。
PEAR コア リリースに含める必要があるすべての PHP コード ファイルについて、ファイルの先頭に次のコメント ステートメントを追加する必要があります: /* vim: set Expandtab tabstop=4 shftwidth= 4: */
// +------------------------------------------ -------- ------------+
// PHP バージョン 4.0 ----------- | -------------------------------------- ------+
// |著作権 (c) 1997, 1998, 1999, 2000, 2001 PHP グループ |
// +----------------- ------------ -------------------------------------- --+
// このソースファイルは対象ですPHP ライセンスのバージョン 2.0、|
// | このパッケージは LICENSE ファイルにバンドルされており、世界中の Web から入手可能です |
// | | Web の場合は、|
// | License@php.net にメモを送信してください。すぐにコピーをお送りします。 ------------------------ ------------------------ --------+
// | 著者: 原作者 |
// | |
// +--------------------- ------------------------ ------------------------+
//
// $Id$
PEAR コア コード ベースにないファイルの場合、ファイルの先頭にも、著作権、ライセンス、作者などを示す同様のコメント ブロックを置くことをお勧めします。同時に、VIM の MODELINE を最初の行に追加して、PEAR のコード スタイルを VIM で維持できるようにします。
CVS タグ:
上記のように、各ファイルに CVS ID タグを追加します。編集または変更するファイルにこのタグがない場合は、追加するか、元のファイルの同様の表現 (「 など)」に置き換えてください。最終更新日」など)
URL サンプル:
定数の名前付け:
PEARの使用を開始する
もちろん、上記の PEAR コーディング ルールに従う必要があります。そうすれば、クラス内でやりたいことを実装できます。次に、これについて説明します。実際、PEAR には 2 つの事前定義クラスが用意されています。 PEAR: これは PEAR の基本クラスであり、すべての PEAR 拡張機能はそれを継承および派生する必要があります。 PEAR_Error: PEAR のエラー処理基本クラス。独自のエラー処理クラスを派生することを選択できます。
一般的に言えば、PEAR のインスタンスを直接作成するのではなく、自分で新しいクラスを派生させ、この新しいクラスのインスタンスを作成する必要があります。 PEAR は基本クラスとして、いくつかの便利な関数を提供します。最も重要なものはデストラクターとエラー処理です
PHP はコンストラクターをサポートしますが、デストラクターはサポートしません。ただし、PHP は、スクリプトが終了する前に登録された関数をコールバックできる register_shutdown_function() 関数を提供します。そのため、PEAR はこの機能を利用してデストラクターを提供します。 mypear という PEAR のサブクラスがある場合、mypear クラスで