爲什麼我會以這種格式看到如此多的評論？

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); 
}