22

私は（ついに）PEAR（php）コーディング標準について調べてきました。

このようなコメントの目的は何ですか:

/** 
*   Here is my comment
*   I Wrote this in a haiku
*   But why put the stars?
*/

これとは対照的に：

/* 
   Here is a comment
   No haiku or 
   anything special, but it still works!
*/
4

6 に答える 6

18

ドキュメントは、DocBlock表記法/** stuff */とも呼ばれます。

PHP 関数、クラスなどを文書化するために使用されます。

/** 
* A test function
*
* @param  foo $bar
* @return baz
*/
function test(foo $bar) { return new baz; }

一部のエディターはこれを有効に利用して、コード インサイト機能を実行します。これは、古い関数宣言を調べるのに費やす時間を短縮する非常に強力なツールです。Aptana と Zend Studio にはこの機能があり、おそらく他の機能も同様です。

これをReflectionと組み合わせて使用​​して、ある種の AOP を実行し、宣言の上にある DocBlock の実行時検査を行うこともできます。実際、Doctrine はこれを使用して、「Active Record」実装用のオブジェクト属性マップを構築しています。

于 2012-10-01T16:50:56.007 に答える
4

二重アスタリスクコメントは、特定のドキュメントシステムで使用されることがあります。ドキュメントシステムはブロックを処理し、@authorや@varなどの特定のキーワードを探します。

単一のアスタリスクコメントは//コメントとして扱われます。

PhpDochttp://www.phpdoc.org/docs/latest/guides/types.htmlを参照して ください

于 2012-10-01T16:49:58.830 に答える
3

私はアジョンとクエンティンに同意します。主に読みやすさです。ただし、もう1つあります。

自動ドキュメントジェネレーター（doxygenなど）があります。

これらのコメントをドキュメントに含めるには、特定のコメント形式が必要です。このスタイルのコメントは、まさにこの目的のために使用されていると思います（次のdoxygenドキュメントページを参照してください-http ://www.doxygen.nl/manual/docblocks.html）

于 2012-10-01T16:49:29.810 に答える
2

読みやすさ。

コードを読んでいる人にコメントセクションを明確に強調します。

于 2012-10-01T16:46:09.770 に答える
2

ほとんどの場合、見た目/読みやすさのためだけだと思います。1 つの画面を超える非常に長いコメント セクションがあるとします。次に、これらのアスタリスクを見ると、最初と最後が見えなくても、それがコメントの一部であることがわかります。

于 2012-10-01T16:47:06.897 に答える