非常に優れた PHP コーディング標準 ページ 1/3

注: これは PHPCMS 開発ドキュメントに記載されているコーディング仕様です。PHPCMS 開発仕様と呼ばれていますが、PHP プログラミングはすべてこうあるべきだと思います。 PHP をたくさん書いてきたので、この標準と比較して多くのコーディングが不足していると感じました。今後修正する必要があります。

Phpcms コーディング仕様
1. 概要…2
3. 標準化の重要性とメリット…3.仕様と原則… 3
4.1. コードのマークアップ… 3
4.3. 記述ルール… 4
4.3.2. {}、if およびスイッチ。 4
4.3.3. 演算子、括弧、スペース、キーワードおよび関数... 5
4.3.4. 関数の定義... 6
4.3.5. .. 6
4.3.6. 多言語の問題... 7
4.4. 命名規則... 8
4.4.1. 変数、オブジェクト、関数名... 8
4.4 .2. 定数... 8
4.5. 変数の初期化と論理チェック... 9
4.7. コードの再利用... 10
4.9. その他の詳細... 10
4.9.1. 呼び出しを含む... 10
4.9.2. エラー報告レベル... 11
5. .. 11
5.1. フィールド... 11
5.1.1. テーブルとフィールドの名前付け... 11
5.1.2. フィールドの構造... 11
5.2. . 12
5.3. パフォーマンスと効率... 13
5.3.1. 固定長テーブルと可変長テーブル... 13
5.3. 操作と取得... 13
5.3.3. 構造の最適化とインデックスの最適化... 14
5.3.4. クエリの最適化... 14
5.3.5. テンプレートの設計... 16
6.1. コードのマークアップ…16
6.2.1. HTML。16
6.2.3. 🎜>6.2.4. インデント... 17
7. ファイルとディレクトリ... 17
7.2. ディレクトリの名前... 18
7.3.空の目次インデックス… 18

1. はじめに
この仕様は、開発者が長期間にわたって蓄積した成熟した経験を統合および洗練させたプログラミング原則で構成されており、優れた一貫したプログラミング スタイル。半分の労力で 2 倍の結果を達成するために、このドキュメントは必要に応じて随時更新されます。
著作権: Shaanxi Jiushi Lulu Network Technology Co., Ltd.、全著作権所有
最終更新日: 2006 年 11 月 20 日

2. 適用範囲
別段の定めがない限り、以下のとおりです。ルール要件は phpcms プロジェクトに完全に適用され、社内の他のほとんどの PHP プロジェクトにも適用できます。

3. 標準化の重要性と利点
ソフトウェア プロジェクトが公的で一貫した標準に準拠しようとすると、プロジェクトに参加する開発者がプロ​​ジェクト内のコードを理解し、明確にすることが容易になります。プログラムのステータス。これにより、新しい参加者がすぐに環境に適応できるようになり、一部の参加者が時間を節約する必要から自分のスタイルを確立したり、生涯にわたる習慣を身につけたりして、他の参加者が読書に過度の時間とエネルギーを浪費することを防ぎます。また、一貫した環境では、コーディング エラーの可能性も減らすことができます。欠点は、人によって基準が異なるため、コーディング スタイルに適応して変更するのに時間がかかり、一時的に作業効率が低下することです。プロジェクトの長期的な健全な発展と、後期におけるチームの作業効率の向上を考慮すると、一時的な作業効率の低下は考慮する価値があり、必ず通過しなければならないプロセスでもあります。標準はプロジェクトの成功の鍵ではありませんが、チームのコラボレーションをより効率的にし、確立されたタスクをよりスムーズに完了するのに役立ちます。
1. プログラマはあらゆるコードを理解でき、プログラムの状態を理解できます。
2. 初心者が環境にすぐに適応できます。
3. PHP を初めて使用する人が、保存する必要性を理由に独自のコードを作成することを防ぎます。スタイルを確立し、生涯にわたる習慣を身につける
4. PHP を初めて使用する人が同じ間違いを繰り返さないようにする
5. 一貫した環境では、間違いを犯す可能性を減らすことができます。 . プログラマには共通の敵があります

4. PHP コーディングの標準と原則

PHP プログラムは、HTML ページに純粋な変数を埋め込むときに、 または を使用して PHP コードを定義できます。 、このフォームを使用できます。
近年、PHP 開発チームはコードの標準化と標準化を提唱しています。PHP の将来のバージョンでは、この短縮形が廃止されるか、廃止される可能性があります。そのため、プログラムの互換性を高めるために、この短縮形を統一します。

4.2. コメント
コメントは、関数を忘れやすいコードに短い紹介コンテンツを追加するためのものです。 C スタイルのコメント「/* */」と標準の C コメント「//」を使用してください。

プログラム開発中に一時的なコードやデバッグ コードを残すことは避けられず、将来忘れられないように、そのようなコードをコメント化する必要があります。すべての一時コード、デバッグ コード、および実験コードには、統一されたコメント マーク「//debug」とその後に完全なコメント情報を追加する必要があります。これにより、プログラムのリリース前と最終的なデバッグの前に、プログラムに疑わしい問題があるかどうかをバッチ チェックすることが容易になります。コード。例:
$num = 1;
$flag = TRUE; //debug ここで $flag に値を割り当てる必要があるかどうかは不明です
if(empty($flag)) {
//ステートメント
}

4.3. 記述ルール

4.3.1. インデント
各インデントの単位は 1 つのタブ (空白文字幅 8 文字) です。プロジェクトの開発者は、コードを書き忘れることによる書式の乱れを防ぐために、エディター (UltraEdit、EditPlus、Zend Studio など) で必須の設定を行っています。
このインデント仕様は、PHP および JavaScript の関数、クラス、論理構造、ループなどに適用されます。

4.3.2. 中括弧 {}、およびスイッチ
の最初の括弧はキーワードと同じ列にあり、最後の括弧はキーワードと同じ列にあります。 if 構造、if および elseif は前後の 2 つの丸で囲まれています。括弧は同じ行上にあり、左右にスペースがあり、すべての中括弧は別の行にある必要があります。さらに、if の後にステートメントが 1 行しかない場合でも、
スイッチ構造では、通常、case ブロックが処理されるときに、後続の case ブロックが処理されるように、中括弧を追加する必要があります。はスキップされるため、ほとんどの場合、ブレークを追加する必要があります。ブレークの位置は、プログラムのロジックによって異なります。ただし、同じスイッチ本体内では、ブレークの位置形式は一貫している必要があります。
以下は、上記の仕様に準拠した例です。
If ($condition)
{
switch ($var)
{
case 1: echo 'var is 1' ; ブレーク;
ケース 2: エコー 'var は 2'; ブレーク 'var は 1 または 2 ではありません';
{
switch ($str)
{
case 'abc':
$result = 'abc';
default:
$result = 'unknown' ;
break;
}
}

4.3.3. 演算子、括弧、スペース、キーワードおよび関数
各演算子は、演算に含まれる値または式の間にあります。両側にスペースが必要です。唯一の例外は、文字連結演算子の両側にスペースがないことです。
左括弧 "(" は関数キーワードと隣接している必要があります。それ以外の場合は、スペースを使用する必要があります。 ;
右括弧 ")" の後に ")" または "." が続く場合を除き、他のすべての括弧はスペースで区切られます。
特に必要でない限り、通常の状況では、文字列はプログラムや HTML には表示されません。
いかなる状況でも、TAB またはスペースを含む空行は PHP プログラム内に表示できません。つまり、そのような空行には TAB やスペースを含めてはなりません。 。同時に、プログラム行の末尾に余分な TAB やスペースを含めることはできません。ほとんどのエディタには、行末のスペースを自動的に削除する機能が備わっています。習慣がうまく育っていない場合は、それを一時的に使用して、大きなプログラム本体の上下に空白行を追加する必要があります。 、2 プログラムブロック間には空行を 1 行のみ使用し、複数行は禁止します。
プログラム ブロックをできるだけ合理的に分割するようにしてください。分割が大きすぎたり小さすぎたりすると、他の人のコードの読み取りや理解に影響を与えます。一般に、より大きな機能定義、論理構造、機能構造に分けられます。 15 行未満のプログラム ブロックには空白行を追加する必要はありません。
説明または表示部分で、内容に中国語、数字、英語が混在する場合は、数字または英語の前後にスペースを追加する必要があります。 。

上記の原則に基づいて、次の例は正しい記述形式を示しています。
$result = (($a 1) * 3 / 2 $num)).'Test';条件 ? func1 ($var) : func2($var);
$condition ? $long_statement
if ($flag)
{

//ステートメント
//15 行以上
}
Showmessage('データを復元するには、restore.php ツールを使用してください。');