コメント

インラインのコメントブロック (docblocks) を必ず表記します。 PEAR パッケージに対するコメントブロックの表記方法については、 サンプルファイル および ヘッダコメントブロック のセクションを参照してください。 詳細な情報は、 http://www.phpdoc.org/ にあります。

インラインドキュメント以外のコメントを書くことも推奨します。一般的な目安として、 コードのある部分を見て「言葉だけで説明したくないな」と思うような場合には、 処理内容を忘れてしまう前にコメントを追加する必要があります。

C 言語形式 (/* */) と標準 C++ コメント (//) のどちらも使用可能です。 Perl/shell 形式のコメント (#) は使用するべきではありません。

関数定義 (Previous) コードの読み込み (Next)
Last updated: Sat, 25 Oct 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: jeff_walter@kace.com
Why exactly are you discouraging the use of # as a comment symbol? I happen to find the c-style comment symbols to be hard to look at...