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

ファイル構造

|--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)。たとえば、クラスの実装に関する詳細は、ドキュメント コメントではなく、クラス宣言の直後の実装ブロック コメントに配置する必要があります。

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

http://www.bkjia.com/PHPjc/322068.htmlwww.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/322068.html技術記事

ファイル構造 |--images |--include |--parameter |--config |--function |--indeximages は、システムによって参照されるファイルで、通常は &

にあります。

🎜🎜