PEAR のコーディング ルールには、インデント ルール、制御構造、関数呼び出し、関数定義、コメント、コードを含む、PHP タグ、ファイル ヘッダー内のコメント ブロック、CVS タグ、URL サンプル、および定数の命名が含まれます。これは簡単な紹介です
apt-get install php-pear
pear install channel://pear.php.net/PHP_ArrayOf-0.2.1
pear ダウンロード チャネル://pear.php.net/PHP_ArrayOf-0.2.1
PEAR コーディング ルール
PEAR コーディング ルールには、インデント ルールと制御構造、関数呼び出しが含まれます、関数定義、コメント、コード、PHP タグ、ファイル ヘッダーのコメント ブロック、CVS タグ、URL サンプル、定数の命名を含む 11 の側面。簡単に説明します:
インデントのルール:
PEAR ではコードをインデントするために 4 つのスペースが必要で、TAB は使用されません。 VIM を使用する場合は、次の設定を ~/.vimrc に追加します:
set Expandtabset shftwidth=4set tabstop=4
Emacs/XEmacs を使用する場合は、必須の Set indent-タブモードを nil にします。
しかし、私のように (X)Emacs を使用して PHP ファイルを編集したい場合は、PEAR コードを作成するときにインデント スタイルが自動的に調整されるように、PHP-MODE をインストールすることを強くお勧めします。 PHP-MODE も優れた機能を多数備えており、リソースリストから最新バージョンの PHP-MODE をダウンロードできます。
制御構造:
ここで説明する制御構造には、while スイッチなどの場合が含まれます。コントロール構造の場合、関数呼び出しと混同されないように、キーワード (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 );さらに、関数の戻り結果に値を代入する場合は、次のようにします。等号の後 代入先の変数の間にはスペースが必要です。同時に、関連する代入ステートメントが連続している場合は、次のように適切なスペースを追加して位置を揃えます。 ##関数定義は " の後に続きます。 1 つの真中括弧" 規則:
$result1 = $foo($param1, $param2, $param3); $var2 = $foo($param3); $var3 = $foo($param4, $param5);上に示したように、オプションのパラメーターはパラメーター リストの最後に配置する必要があり、常に意味のある関数値を返すようにしてください。
コメントについて:
クラスのオンライン ドキュメントの場合、JavaDoc と同様に、PHPDoc によって変換できる必要があります。PHPDoc も PEAR アプリケーションです。より詳細な概要については、http://www.phpdoc.de/ にアクセスしてください。表示します。クラスのオンライン ドキュメントに加えて、ドキュメント以外のコメントを使用してコードを説明することをお勧めします。コードの一部を見ると、次のように考えます: ああ、そうは思わないそのため、ドキュメントに注意深く説明する必要があります。その後、コードの動作を忘れないように、このコードに対して簡単なコメントを作成した方がよいでしょう。コメントの形式については、C の /* */ と C の / / は問題ありませんただし、Perl やシェルの # コメント メソッドは使用しないでください。条件付きでクラス ファイルをインクルードする場合は、include_once を使用する必要があります。これにより、インクルードするファイルは 1 回だけインクルードされ、これら 2 つのステートメントは同じファイル リストを共有するため、この 2 つの間の混同を心配する必要はありません。
PHP コード タグ:
常に bb9bd6d87db7f8730c53cb084e6b4d2d を使用します。単純に b26da186e11666e6dd99f28d6205715c を使用する代わりに PHP コードを使用すると、PEAR の互換性が確保され、クロスプラットフォームの移植も容易になります。
ファイル ヘッダーのコメント ステートメント:
PEAR コア リリースに含める必要があるすべての PHP コード ファイルについて、先頭に次のコメント ステートメントを追加する必要があります。ファイルの:/* vim: set expandtab tabstop=4 shiftwidth=4: */ // +----------------------------------------------------------------------+ // | PHP version 4.0 | // +----------------------------------------------------------------------+ // | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Authors: Original Author | // | Your Name | // +----------------------------------------------------------------------+ // // $Id$
对于不在PEAR核心代码库中的文件,建议你也在文件的开始处有这样一个类似的注释块,标明版权,协议,作者等等。同时也在第一行加入VIM的MODELINE,这样在VIM中能够保持PEAR的代码风格。
CVS标记:
如上面所展示那样,在每个文件中加入CVS的ID标记,如果你编辑或修改的文件中没有这个标记,那么请加入,或者是替换原文件中相类似的表现形式(如"Last modified"等等)
URL样本:
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。
常量命名:
常量应该尽量使用大写,为了便于理解,使用下划线分割每个单词。同时,你应该常量所在的包名或者是类名作为前缀。比如,对于Bug类中常量应该以Bug_开始。
以上是PEAR的编码规则,详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则,你也可以参考一下现有PEAR核心模块的代码。
推荐学习:php视频教程
以上がPHPでpear拡張パッケージを使用する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。