PHPコーディング標準のコメントとファイル構造を理解して学習する

ファイル構造

|
|――画像
|――インクルード
|――パラメータ
|――設定
| ――function
|――index

images はシステムが参照したいファイルを格納します。通常、パラメータ ファイルはパラメータに、設定ファイルは config に格納されます。 function. にはJavaScriptのメソッドなどのファイルが格納されており、その中に機能モジュールの分類に応じて各関数のクラスを入れます

ファイル名

フォルダーの名前は通常英語で、長さは 20 文字を超えず、名前には小文字が使用されます。特別な状況を除いて、一般的なフォルダー名には、images (ストレージ グラフィック ファイル)、flash (ストレージ Flash ファイル)、style (ストレージ CSS ファイル)、script (ストレージ JavaScript スクリプト)、inc (ストレージ インクルード ファイル) が使用されます。 、リンク (フレンドリーなリンクを保存)、メディア (マルチメディア ファイルを保存) など。ファイル名は、英小文字、数字、アンダースコアの組み合わせである必要があります。

ブロック コメント

ブロック コメントは通常、ファイル、メソッド、データ構造、アルゴリズムの説明を提供するために使用されます。ブロック コメントは、すべてのファイルの先頭とすべてのメソッドの前に配置されます。これらはメソッド内など、他の場所でも使用できます。関数やメソッド内のブロック コメントには、記述されているコードと同じインデントが必要です。

ブロック コメントとコードを区切るために、ブロック コメントの先頭に空行が必要です。例:

/*
* ブロック コメント
*/

ブロック コメントは /*- で始めることができるため、indent(1) はコード ブロックを再配置せずにコード ブロックの先頭として認識できます。

/*-
* 無視したい場合は、特別な形式のブロック コメントを使用してください
*
* one
* two
* three
*/

注: indent(1) を使用しない場合は、コード内で /*- を使用する必要はありません。また、他の人がコード上で indent(1) を実行する可能性を考慮する必要もありません。 。

単一行コメント

短いコメントは 1 行に表示され、その背後にあるコードと同じインデント レベルを持つことができます。コメントを 1 行で記述できない場合は、ブロックコメントを使用してください。単一行のコメントの前には空行を入れる必要があります。コード内の 1 行コメントの例を次に示します。

if (条件) {

/* 次のコードが実行される条件*/
...
}

末尾のコメント

非常に短いコメントは、説明するコードと同じ行に置くことができますが、コードとコメントを区切るために十分な空白が必要です。コメント。複数の短いコメントがコードの大きなブロック内に出現する場合、同じインデントを持つ必要があります。

コードの末尾コメントの例を次に示します。

if ($a == 2) {
return TRUE; /* 単一の条件の説明*/
} else {
return isPrime($a); /* 残りの条件*/
}

行末コメント

コメント区切り文字「//」を使用すると、行全体または行の一部をコメントアウトできます。通常、複数行のテキストをコメントアウトするためには使用されませんが、複数行のコードをコメントアウトするために使用できます。以下に 3 つのスタイルすべての例を示します:

if ($foo > 1) {

// 2 番目の使用法。

* このクラスのいくつかの側面について説明します...

}
else {

return false; // 戻り値の理由を説明します

}

//if ($bar > 1) {
//
// / / 3 番目の使用法
//
//}
//else {

// return false;

//}

ドキュメント コメント

ドキュメントのコメントでは、PHP のクラス、コンストラクター、メソッド、フィールドについて説明します。各ドキュメント コメントはコメント区切り文字 /***/ 内に配置され、1 つのコメントがクラスまたはメンバーに対応します。このコメントは宣言の前に置く必要があります:


/**
* このクラスについての説明

*/

class Example {

最上位クラスはインデントされていませんが、そのメンバーはインデントされていることに注意してください。クラスを説明するドキュメント コメントの最初の行 (/**) はインデントする必要はありません。ドキュメント コメントの後続の行は、スペース 1 つ分インデントされます (アスタリスクが垂直に揃うように)。コンストラクターを含むメンバーのドキュメント コメントの最初の行は 4 つのスペースでインデントされ、後続の各行は 5 つのスペースでインデントされます。

ドキュメントに記述するのに適さないクラス、変数、またはメソッドに関する情報を提供したい場合は、実装ブロックのコメント (5.1.1 を参照) を使用するか、宣言の直後に Single を使用できます。 -行のコメント (5.1.2 を参照)。たとえば、クラスの実装に関する詳細は、ドキュメント コメントではなく、クラス宣言の直後の実装ブロック コメントに配置する必要があります。

プログラムはドキュメント コメントの後の最初の宣言をメソッドまたはコンストラクターの定義ブロックに関連付けるため、ドキュメント コメントをメソッドまたはコンストラクターの定義ブロックに配置することはできません。