为什么我会以这种格式看到这么多评论？

Question

我看到这么多PHP评论的格式为：

/**
 * (c) Copyright Someone 2009
 * legal crap
 * blorp
 */

这只是按惯例，还是有原因的？我认为这只是一种方式，有些人做了，但我现在想知道我的语法荧光笔做到了这一点：It's red without asterisks http://img.skitch.com/20090628-ef9riek8m5d75udssrqewhkasn.png

仅当我开始使用此格式，然后停止使用它时才会发生这种情况。为什么评论是这样做的？

Answer 1

这些是phpDocumentor条评论。文档生成器（按照惯例）使用以/**开头的注释来为项目创建文档。这是quick start guide for phpDocumentor。

Answer 2

许多文档生成器可以读取这样的格式。

许多IDE也使用它来帮助编码。 （例如Zend Studio和其他人）

/**
 * Title
 * 
 * @author Me
 * @copyright 2009
 * @name test
 * 
 * @param int $foo
 * @return bool 
 */
function test($foo)
{
    return is_int($foo);
}