日本語
日本語
人気のある動的プログラミング言語として、PHPは、コードの正しさに注意を払うことに加えて、標準コードを書く上でも重要です。標準化されたコードは、読みやすさと保守性を向上させるだけでなく、チームのコラボレーションとコードリファクタリングを促進します。この記事では、開発効率とコード品質の向上に役立つPHPライティング仕様の重要なポイントを共有します。
PHPファイルは下線（Snake_Case）という名前で、ファイル拡張子は均一に.phpです。ファイル名は簡潔で、ファイルの関数を正確に反映する必要があります。
// お勧めしません
file.php
My_PHP_Class.class.php
<p>// 推薦する<br>
user_login.php<br>
user_login_check.php<br>
MyPhpClass.php<br>
クラス名には、各単語の最初の文字が大文字になり、アンダースコア接続を避けて、Camelcaseという名前の名前にする必要があります。
// お勧めしません
my_class.php
My_Class.php
My_Class_Obj.php
<p>// 推薦する<br>
MyClass.php<br>
MyClassObject.php<br>
小文字のアンダースコア（snake_case）を使用して、記述性と読みやすさを維持することをお勧めします。
// お勧めしません
myfunction()
myFunction()
MyFunction()
<p>// 推薦する<br>
my_function()<br>
user_login_check()<br>
コードインデンテーションは、4つのスペースを均一に使用し、タブ文字の使用を避け、コード階層を明確で一貫性を保ちます。
// お勧めしません
if($a){
echo $a;
}
if($b){
echo $b;
}
<p>// 推薦する<br>
if ($a) {<br>
echo $a;<br>
}<br>
if ($b) {<br>
echo $b;<br>
}<br>
「K＆R」スタイルでは、ブレースは1つのラインを占めています。制御構造は、左ブラケットの前にスペースを離れる必要があり、関数は、左ブラケットが関数の前にスペースを離れないことを宣言します。
// お勧めしません
if($a){
echo $a;
}else{
echo 0;
}
<p>// 推薦する<br>
if ($a) {<br>
echo $a;<br>
} else {<br>
echo 0;<br>
}<br>
バイナリ演算子、コンマ、およびセミコロンの後にスペースが続く必要があり、統一オペレーター、ブラケット、変数名の間にスペースがないはずです。
// お勧めしません
if($a==1){
echo $a+1;
}
<p>// 推薦する<br>
if ($a == 1) {<br>
echo $a + 1;<br>
}<br>
コメントはコードの保守性を改善するための鍵であり、過度に複雑な技術用語を避けるために簡潔で標準化する必要があります。
各ファイルには、ファイルの目的、著者、作成時間などの基本情報を含める必要があります。
/**
* ファイル名：MyClass.php
* ファイルの使用：デモPHPクラス定義
* 著者：Tom
* 作成時間：2021年9月20日
*/
関数のコメントには、他の人が理解しやすいメンテナンスのために、関数の説明、パラメーターの説明、返品値の説明を含める必要があります。
/**
* 関数の紹介：2つの数値の合計を計算します
* パラメーターの説明：$a - 最初の番号，$b - 2番目の番号
* 返品値：2つの数字の合計
*/
function sum($a, $b) {
return $a + $b;
}
不必要な略語と専門用語を減らすために、自然言語でコメントを書いて、コメントを理解しやすくします。
テストは、コードの品質を確保するための重要な部分です。コードを作成した後、さまざまなテストをタイムリーに実行する必要があります。
明確に定義された入力を使用してコードロジックを検証して、機能が期待と一致していることを確認します。
返された結果の正確性を検証するための方法または関数のテストケースを記述します。
システムの安定性と負荷を負担する能力は、ストレステストを通じて評価されます。
この記事では、命名、コードスタイル、注釈、テスト、コードの品質と開発効率の包括的な改善まで、PHPコードの仕様を体系的に整理します。優れたコーディング習慣は、高品質のコードベースを構築するための基礎であり、PHP開発者に役立つことを望んでいます。
