PHPコードコメント標準

このことは非常に一般的で有名です、

その構文と実用的なアプリケーションについて説明します。

PHPでは、すべてがかなりOOPになります。

すぐに予約します。形式はクラス、そのメソッド、プロパティに適用されます。

そして、私たちの労働の終わりに、私たちはダブルスからバカを得るべきではないように、

しかし、美しく書かれたドキュメント、この形式を適用する必要があります。

練習する



例:



一見、それほどきれいに見えませんが、多くの利点があります。

主な利点は標準です。 次に、ZendとEclipseが提供する快適さについて:



ヒントとして、開発環境には機能の詳細な説明が表示され、

入力の形式と最終的に得られるものを確認できます。 「しかし、それだけでは©ではありません」

ドキュメントを自動的に作成するシステムがあります。

そして彼らの助けを借りて、私たちのプロジェクトの完全な説明を得ることができます、

上記のコメントのみに基づいています。 それはどのように見えますか:



このページは、ZDEに組み込まれているphpDocumetorシステムによって生成されます。



コメント構文



関数またはメソッドの構文

/ **

*名前または簡単な説明(クラス、メソッド、プロパティ、関数)

*

*詳細な説明

*数行

*

* @tag_name値

*データ型を返す

* /



プロパティの構文

/ **

*説明

*

* var variable_type

* /

最後に、説明付きのタグのリスト:



phpDocumentorマニュアルの全リスト。



All Articles