### phpdoc注釋 常見的類型 * [ ] @author Author Name 幫助獲得負責某個特定元素的人的信息(強烈推薦使用這一標簽) [<author@email.com>] * [ ] @copyright Copyright 可指定代碼的版權所有者 * [ ] @deprecated [version 可通知代碼的使用者這個元素不再被使用并且已經被替換 * [ ] @example [pathlurl] 可引用一個例子，闡釋如何使用這個元素。第二個參數可以是一個路徑也可以是 description 一個完整的URL * [ ] @filesource 可用來表示希望讓文件源出現在文檔中 這一標簽只能出現在頁面級別的塊中，在其他地方出現將會被忽略 * [ ] @global datatype 說明了全局變量的數據類型。這一標簽必須緊貼在全局變量的前面，并且只對 description phpDocumentor解析器起作用。對于基于反射技術的解析器用處不大 * [ ] @ignore 通知解析器忽略這個元素，并且不將它包含在文檔中 * [ ] @internal 可以隱藏特定的信息，使之不出現在公開文檔中。可以用在內嵌的注釋內容中或者新行注釋中 * [ ] @license url [license] 指定此軟件授權信息的URL，還可以說明授權者的姓名 * [ ] @link url [description] 在文檔中包含一個鏈接。這個標簽可以用在內嵌的內容中 * [ ] @param datatype 說明與函數和方法關聯的參數。這可能是最重要的標簽。變量名稱參數可以包括， $variablename[...] 符號以表示函數可以傳入不定數量的其他參數 * [ ] @return datatype 說明了函數或方法返回的數據類型。這可能是第二個重要的標簽，并且它是在PHP description 中包含關于返回數據的元數據的唯一方法。推薦所有具有返回值的函數使用這一標簽 * [ ] @see reference 引用另外一個元素的文檔。在這里可以使用不同類型的指針，包括文件、函數名稱、類方法以及其他許多類型的指針。多個指針值可以用逗號隔開。這個標簽也可以用在內嵌的內容中 * [ ] @since version 用于說明這個元素第一次出現的版本信息 * [ ] @source startoffset 用于包括內嵌于文檔中的相關聯元素的部分源代碼內容(這個元素只能用在內嵌 [endoffset] 的內容中)。起始偏移量是希望在文檔中包含的起始行號，而終止偏移量是希望包含的行的數量。如果省略終止偏移量，起始偏移量到元素結束位置之間的所有代碼都將被包含在內 * [ ] @todo description 包含了待完成工作的信息，或者待解決問題的信息 * [ ] @var datatype 說明了類變量的類型，類變量也被看作是屬性 * [ ] @version 指定了元素的當前版本號