phpdocumentor是強大的**注釋生成器,本文對各個引數進行了簡單地的總結:
@abstract
-------------
使用@abstract標記來宣告乙個方法,類變數或類必須重新定義子類中是有效的。
@abstract
-------------
使用@abstract標記來宣告乙個方法,類變數或類是抽象的。
乙個類中,只要有乙個抽象方法,這個類必須被宣告為抽象類。
抽象方法在子類中必須被重寫。
抽象類在被繼承後,其中的抽象方法不能被重寫。
@access
-------------
訪問許可權public、protected、private
@author
-------------
作者@category
-------------
分類,例如(library,helper,view等)
-------------
版權@deprecated
-------------
過時的,即將被棄用
@example
-------------
包括帶有語法高亮的外部示例檔案
@final
-------------
final類不能被繼承,final方法不能被重寫
@filesource
-------------
建立包含當前檔案和鏈結的,語法高亮顯示的參照檔案源**
@global
-------------
全域性變數
@ignore
-------------
使用@ignore防止文件記錄的元素,如重複的元素。
@internal
-------------
標記為私有,軟體專案內部的
@license
-------------
指向許可檔案的超連結
@link
-------------
超連結@method
-------------
乙個類的「魔術」方法
@name
-------------
phpdocumentor識別global變數中的@name標記(結合@global),用它來重新命名乙個文件的global變數以增強可讀性。乙個global變數必須以($)開始,否則phpdocumentor會忽略此標記並報錯。
@package
-------------
指定包來組織類或方法。@package只能用於文件程式頁面或類。
@param
-------------
函式的引數
@property
-------------
「魔術」屬性
@return
-------------
指定乙個函式或方法的返回值型別
@see
-------------
指向元素的文件的鏈結
@since
-------------
從哪個版本開始將其新增進package
@static
-------------
靜態屬性或方法,無需例項化即可呼叫
@staticvar
-------------
函式或方法中的靜態變數
@subpackage
-------------
和@package一起為文件組織php檔案
@todo
-------------
未來可能有變動
@tutorial
-------------
顯示乙個指向該檔案的教程
@uses
-------------
顯示指向元素的文件的鏈結,並建立乙個反向鏈結在其他元素的文件
@var
-------------
變數@version
-------------
版本
phpdocumentor 學習筆記(一)
phpdocumentor是一款可以生成 注釋文件的外掛程式,用起來及其方便。我們只要遵守他的注釋規則然後生成文件即可。我這裡用的是phpdocumentor1.4.4版本。首先進行安裝,我這裡安裝的很順利,用的php直接包含了go pear.phar 沒在這個上面多費功夫。直接使用命令列自動安裝。...
修改PhpDocumentor預設編碼
最近專案需要phpdoc生成文件,首先安裝phpdocumentor,利用pear安裝 切換使用者 su root 安裝phpdocumentor pear install phpdocumentor 生成文件 phpdoc o html frames earthli d customservice...
如何正確安裝phpDocumentor
注意 以下假定使用者使用php5,window系統!安裝phpdocumentor第一種方法 下 載後,如果希望使用命令列介面,解壓到任意路徑 假設在c program files 修改c program files phpdocumentor 1.4.2 phpdoc.bat。把第一行修改set ...