PHP經驗——PHPDoc PHP注釋的標準文檔(翻譯自Wiki)

來源:互聯網
上載者:User

標籤:使用   strong   檔案   io   時間   type   

標記 用途 描述
@abstract   抽象類別的變數和方法
@access public, private or protected 文檔的訪問、使用許可權. @access private 表明這個文檔是被保護的。
@author 張三 <[email protected]> 文檔作者
@copyright 名稱 時間 文檔著作權資訊
@deprecated version 文檔中被廢除的方法
@deprec   同 @deprecated
@example /path/to/example 文檔的外部儲存的樣本檔案的位置。
@exception   文檔中方法拋出的異常,也可參照 @throws.
@global 類型:$globalvarname 文檔中的全域變數及有關的方法和函數
@ignore   忽略文檔中指定的關鍵字
@internal   Team Dev內部資訊
@link URL 類似於license 但還可以通過link找到文檔中的更多個詳細的資訊
@name 變數別名 為某個變數指定別名
@magic   phpdoc.de compatibility
@package 封裝包的名稱 一組相關類、函數封裝的包名稱
@param 如 [$username] 使用者名稱 變數含義注釋
@return 如 返回bool 函數返回結果描述,一般不用在void(空返回結果的)的函數中
@see 如 Class Login() 檔案關聯的任何元素(全域變數,包括,頁面,類,函數,定義,方法,變數)。
@since version 記錄什麼時候對文檔的哪些部分進行了更改
@static   記錄靜態類、方法
@staticvar   在類、函數中使用的靜態變數
@subpackage   子版本
@throws   某一方法拋出的異常
@todo   表示檔案未完成或者要完善的地方
@var type 文檔中的變數及其類型
@version   文檔、類、函數的版本資訊

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.