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

php standards comments pear

2022-08-30 17:47:44

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

答案 1

该文档也称为 DocBlock 表示法。/** stuff */

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

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

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

您还可以将其与反射结合使用来执行某种AOP，对声明上方的DocBlock进行运行时检查。事实上，Doctrine使用它来为其“Active Record”实现构建对象属性映射。

答案 2

双星号注释有时被某些文档系统使用。文档系统将处理块并查找某些关键字，如@author或@var。

单个星号注释将被视为 // 注释。