php - php注释中额外星号的目的是什么？

Question

我(终于)一直在阅读 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!
*/

Answer 1

/** stuff */ 文档也称为 DocBlock符号。

它用于记录 PHP 函数、类等。

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

一些编辑器充分利用它来执行他们的 Code Insight 功能，这是一个非常强大的工具，可以减少您查看旧函数声明所花费的时间。 Aptana 和 Zend Studio 具有此功能，可能还有其他功能。

您还可以将它与 Reflection 结合使用做某种 AOP，对声明上方的 DocBlock 进行运行时检查。事实上，Doctrine 使用它来构建一个 object attribute map他们的“事件记录”实现。