PHP コーディング仕様のコメントとファイル構造の説明_PHP チュートリアル-PHPチュートリアル-php.cn

PHP コーディング仕様のコメントとファイル構造の説明_PHP チュートリアル

WBOY

リリース： 2016-07-21 15:36:41

オリジナル

871 人が閲覧しました

ファイル構造

|--images
|--include
|--parameter
|--config
|--function
|--index
images Include は、システムが参照したいファイルを格納します。一般的には、parameterにパラメータファイルを、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 (condition) {
/* 次のコードが実行される条件 */
...
}
末尾のコメント
非常に短いコメントは、行を説明するコードと同じコードですが、コードとコメントを区切るために十分な空白が必要です。複数の短いコメントがコードの大きなブロック内に出現する場合、同じインデントを持つ必要があります。
以下はコード内の末尾コメントの例です:

コードをコピーしますコードは次のとおりです:

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

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

コードをコピーコードは次のとおりです:

 
if ($foo > 1) { 
 // 2 番目の使用法 
 ... 
} 
else { 
 return false; // 戻り値の理由を説明します 
} 
//if ($bar > 1) { 
// 
// // 3 番目の使用法 
// ... 
//} 
// else { 
 // false を返す 
//} 

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

/**
* このクラスの
* このクラスのいくつかの側面について説明します...
を説明します
*/
class Example { &

最上位クラスはインデントされておらず、そのメンバーはインデントされていることに注意してください。凹んだ。クラスを説明するドキュメントコメントの最初の行 (/**) はインデントする必要はありません。ドキュメントコメントの後続の行は、スペース 1 つずつインデントされます (アスタリスクが垂直方向に揃うように)。コンストラクターを含むメンバーのドキュメントコメントの最初の行は 4 つのスペースでインデントされ、後続の各行は 5 つのスペースでインデントされます。ドキュメントに記述するのに適さないクラス、変数、またはメソッドに関する情報を提供したい場合は、実装ブロックコメント (5.1.1 を参照) または宣言の直後に単一行コメント (5.1 を参照) を使用できます。 2)。たとえば、クラスの実装に関する詳細は、ドキュメントコメントではなく、クラス宣言の直後の実装ブロックコメントに配置する必要があります。

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

にあります。

🎜🎜