2012-10-01 21 views
17

私は(最終的に)PEAR(php)コーディング標準を読んできました。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! 
*/ 
+9

私は近い票を理解できません。正当な質問です。このようにコメントする本当の理由があります。 – bstpierre

答えて

13

/** stuff */文書もDocBlock表記法とも呼ばれます。一部のエディタは、彼らのコード・インサイト機能、時間を短縮し、非常に強力なツールを実行するには、このを十分に活用

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

あなたが見て費やす必要がPHPの関数、クラスなどを文書化するために使用されますあなたの古い関数宣言。 AptanaとZend Studioにはこの機能があります。

また、Reflectionと組み合わせて使用​​して、宣言よりも上のDocBlockのランタイム検査を実行することもできます。実際には、Doctrineはそれを使って "Active Record"実装のためにobject attribute mapを構築します。

2

可読性

は次のようにコメントの目的は何ですか。

コードを読んでいる人にはコメントセクションがはっきりと強調表示されています。

+0

それは私が思ったことです...それは厳密に読みやすくするためですか?その他の利点はありませんか? –

+1

コンテキスト強調表示をしないエディタを使用している場合は、長いコメントブロックの明確化と識別に役立ちます – Dave

+2

これはあまり真実ではありません。技術的には、星印のアスタリスクを使用するのが形式的です。しかし、phpdocのようなドキュメントシステムはそれに依存しています。 – dcbarans

2

私はそれが外観/可読性のためだけであると思います。 1つの画面を超える非常に長いコメントセクションがあるとします。これらのアスタリスクを見ると、開始と終了を見ることができない場合でも、コメントの一部であることがわかります。

3

私はajonとQuentinに同意します。主に読みやすさです。しかし、もう一つ事があります。

自動文書生成プログラム(doxygenなど)があります。

これらのコメントには、これらのコメントをドキュメントに含めるために、特定のコメントの書式設定が必要です。私はこのコメントスタイルがこの目的のために正確に使用されていると信じています(doxygenドキュメンテーションの次のページをご覧ください)

+0

さて、私はdoxygenを検索するときにこれを見つけたので、もう少し詳しく* –

3

二重アスタリスクコメントは、特定のドキュメントシステムによってはいつか使用されます。ドキュメントシステムはブロックを処理し、@authorや@varのような特定のキーワードを探します。

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

参照PHPDOC

http://www.phpdoc.org/docs/latest/guides/types.html
1

あなたがPHPを編集するための優れたフリーテキストエディタのjEditを使用している場合は、それが動詞であるかを示すために、異なる色でコードをハイライトなどの変数ものです

あなたは/ *でブロックをコメントアウトした場合... * /ブロック内のすべてがオレンジ色になり、コードを読みにくくなります。

/** ... * /とコメントアウトすると、ブロック内のすべての部分が、コードのさまざまな部分を強調表示する異なる色のセットに変更されます。つまり、コードは非常に読みやすくなります。

PS。メモ帳などを使用してPHPコードを編集する場合は、jEditを取得することを強くお勧めします。それはあなたに莫大な時間と欲求を救うでしょう。 {}、()などの始まりと終わりを自動的に示すようなもの。

関連する問題