PHPコーディング標準(8)_PHPチュートリアル

4.5 ドキュメントのコメント

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

/**
* このクラスの一部を説明します
* このクラスのいくつかの側面を説明します...

*/

class Example { ) はインデントする必要はありません。後続のドキュメント コメントは 1 行につき 1 スペースずつインデントされます (アスタリスクが垂直方向に揃うように)。コンストラクターを含むメンバーのドキュメント コメントの最初の行は 4 つのスペースでインデントされ、後続の各行は 5 つのスペースでインデントされます。

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

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

http://www.bkjia.com/PHPjc/532596.htmlwww.bkjia.com本当http://www.bkjia.com/PHPjc/532596.html技術記事 4.5 ドキュメント コメント ドキュメント コメントでは、PHP クラス、コンストラクター、メソッド、フィールドについて説明します。各ドキュメント コメントは、コメント区切り文字 /**... 内に配置されます。

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

プログラムはドキュメント コメントの後の最初の宣言をメソッドやコンストラクターの定義ブロックに関連付けるため、ドキュメント コメントをメソッドまたはコンストラクターの定義ブロックに配置することはできません。 🎜🎜🎜🎜🎜🎜 🎜🎜🎜http://www.bkjia.com/PHPjc/532596.html🎜🎜www.bkjia.com🎜🎜tru​​e🎜🎜http://www.bkjia.com/PHPjc/532596.html🎜🎜技術記事🎜🎜 4.5 ドキュメントのコメント ドキュメントのコメントでは、PHP のクラス、コンストラクター、メソッド、フィールドについて説明します。各ドキュメント コメントはコメント区切り文字 /**&*/ 内に配置され、1 つのコメントがクラス&🎜🎜🎜🎜に対応します。 🎜🎜