Php-coding-standard
提供:Dev Guides
PHP-コーディング標準
すべての企業は、ベストプラクティスに基づいて異なるコーディング標準に従います。 多くの開発者がさまざまなモジュールで作業している可能性があるため、コーディング標準が必要です。独自の標準を発明し始めると、ソースは非常に管理しにくくなり、そのソースコードを将来維持することが難しくなります。
コーディング仕様を使用する理由はいくつかあります-
- ピアプログラマは、作成するコードを理解する必要があります。 コーディング標準は、すべてのチームがコードを解読するための青写真として機能します。
- 一貫したコーディングによって達成されるシンプルさと明快さは、よくある間違いからあなたを救います。
- しばらくしてコードを修正すると、そのコードを理解しやすくなります。
- ソフトウェアの品質を高めるために、特定の標準に従う業界標準。
PHPでコーディングする際に従うべきガイドラインはほとんどありません。
- インデントと行の長さ-4スペースのインデントを使用し、タブを使用しないでください。コンピューターによってタブの設定が異なるためです。 コードを読みやすくするために、行を約75〜85文字の長さにすることをお勧めします。
- 制御構造-これらには、if、for、while、switchなどが含まれます。 制御ステートメントは、関数呼び出しと区別するために、制御キーワードと開き括弧の間にスペースを1つ入れる必要があります。 技術的にオプションである場合でも、常に中括弧を使用することを強くお勧めします。
例
if ((condition1) || (condition2)) {
action1;
}elseif ((condition3) && (condition4)) {
action2;
}else {
default action;
}
次のようにスイッチステートメントを書くことができます-
switch (condition) {
case 1:
action1;
break;
case 2:
action2;
break;
default:
defaultaction;
break;
}
- 関数呼び出し-関数は、関数名、開き括弧、最初のパラメーターの間にスペースを入れずに呼び出す必要があります。コンマと各パラメーターの間にはスペースがあり、最後のパラメーター、右括弧、セミコロンの間にはスペースはありません。 ここに例があります-
$var = foo($bar, $baz, $quux);
- 関数定義-関数宣言は「BSD/Allmanスタイル」に従います-
function fooFunction($arg1, $arg2 = '') {
if (condition) {
statement;
}
return $val;
}
- コメント-Cスタイルのコメント(/* */)と標準のC ++コメント(//)はどちらも問題ありません。 Perl/シェルスタイルのコメント(#)の使用は推奨されません。
- * PHPコードタグ*-PHPコードを区切るには、常に<?php?>を使用します。<? ?>速記。 これは、PHPに準拠するために必要であり、さまざまなオペレーティングシステムとセットアップにPHPコードを含める最も移植性の高い方法です。
- 変数名-
- すべて小文字を使用
- 単語の区切り文字として「_」を使用します。
- グローバル変数の前に「g」を付ける必要があります。
- グローバル定数は、「_」区切り文字付きのすべて大文字にする必要があります。
- 静的変数の先頭には「s」を付けることができます。
- Make Functions Reentrant -関数は、関数がリエントラントになるのを防ぐ静的変数を保持すべきではありません。
- 宣言ブロックの整列-宣言のブロックを整列する必要があります。
- 行ごとに1つのステートメント-ステートメントが非常に密接に関連している場合を除き、行ごとに1つのステートメントのみが存在する必要があります。
- 短いメソッドまたは関数-メソッドは、コードの単一ページに制限する必要があります。
PHPプログラムを作成する際に考慮すべき点がさらに多くあります。 すべての意図は、コードプログラミング全体で一貫性を保つことであり、コーディング標準に従う場合にのみ可能です。 異なるものが好きな場合は、独自の標準を作成できます。