DoitPHP コーディング仕様書

適用範囲 特に指定がない限り、次のルール要件は DoitPHP プロジェクトに完全に適用されます (注: DoitPHP を使用して開発された PHP プロジェクトではなく、Doitphp の PHP フレームワーク ファイル)。次のコーディング標準が気に入った場合は、他の PHP 開発プロジェクトでも使用できます。​

標準化の重要性と利点 「ルールもなく、四角形もない。」 ソフトウェア プロジェクトの開発が公的で一貫した標準に準拠している場合、チーム メンバー全体が一貫したコーディング スタイルを形成して維持し、プロジェクト ドキュメント全体が 1 人で作成されます。 。各プログラマのコードは他の人にとって理解しやすく、コードの保守性が向上し、ソフトウェアの保守コストが削減されます。同時に、新しい参加者は環境にすぐに適応できるため、チーム開発協力の効率が最大化されます。長期的に標準化されたコーディングにより、開発者は適切なコーディング習慣を身につけ、コーディング エラーの可能性を減らし、より厳密な思考を身につけることもできます。仕様を「文書化」する目的は、コーディング標準を明確にすることです。私たちは、標準がプロジェクト成功の鍵ではないと信じていますが、標準はチームのコラボレーションをより効率的にし、設定されたタスクをよりスムーズに完了するのに役立ちます。

PHP コーディング仕様と原則 1. ファイル形式 1.1. ファイルエンコーディング: ファイルエンコーディングは UTF-8 に統一されます (注: UTF-8 以外の BOM)。 1.2. PHP コード タグ: PHP コードを定義するには、いつでも「<?php ?>」を使用します。また、「<? ?>」は禁止となります。 PHP のみを含むコード ファイルの場合は、余分なスペースやその他の文字がコードに影響を与えるのを防ぐために、ファイル末尾の「?>」を無視することをお勧めします。 1.3. インデント規則: TAB の代わりに 4 つのスペースをインデントに使用します。これはすでにPHP業界の標準となっており、「歴史の流れに逆らう」つもりはありません。スペースを使用する主な理由は、コードをすっきりと整然と見せるためです。エディターが異なれば、TAB タブ文字の長さは異なりますが、スペースは同じであるためです。 TAB を使用する場合は TAB キーを押すことで問題を解決できますが、スペースを使用するとスペースバーを 4 回押す必要があり、明らかに開発効率に影響します。現在、多くのエディタではデフォルトで TAB が 4 つのスペースを占めるように設定されています (スペースの数はエディタで調整できます)。その場合、開発効率を向上させるために、安心して TAB を使用できます。このインデント仕様は、JavaScript の関数、クラス、論理構造、ループなどにも適用されます。 1.4. コードの内容: 各行の末尾に余分なスペースや TAB 文字を使用することはできません (エディターがファイルを Unix 形式で保存していることを確認してください。つまり、行は改行で終了します)。言語パックの注釈構成ファイルを除いて、中国語はどこにも存在しません。 1.5. コード コメント: ファイルには明確なコード コメントが必要であり、コメント スタイルは phpDocumentor 標準を採用しています。