2010年9月5日 星期日

[轉貼] JSDoc 及 PHPDocument 註解撰寫差異

本篇文章轉貼自: 林中路 - JSDoc 與 phpDocumentor


JSDoc
  • @fileoverview :  檔案描述, 鷹置於檔案開始.
  • @author : 作者. 我寫我, 你寫你.
  • @version : 指定版本訊息.
  • @see : 建立一個鏈結,指出相關於的類別描述文件.
  • @require : 建立一個鏈結,指出必要的類別描述文件.
  • @deprecated :
  • @param : 參數說明.
  • @argument : 引數說明.
  • @return : 返回值說明.
  • @throws :
  • @exception :
  • @private :
  • @final : 常數值說明.
  • @ignore : 忽略此函式.
  • @class : 類別說明.
  • @constructor : 初始建構式說明.
  • @type : 返回值類型說明.
  • @extends : 繼承說明.
phpDocumentor
  • @abstract : 抽象類型的標記說明. 使用範圍 method, class variable, class 等.
  • @access : 標記可駐明關鍵字的存取權限:private、public 或 proteced. 使用範圍 class, function, var, define, module 等.
  • @author : 作者. 我寫我, 你寫你.
  • @category :
  • @copyright : 版權註解, 使用範圍 class, function, var, define, module, use 等.
  • @deprecated : 棄用標示, 使用範圍 class, function, var, define, module, constent, global, include 等.
  • @example : 高亮顯示註解文字段落,
  • @const : 標示定義的常量, 使用範圍 define.
  • @final : 完成, 可用來標明此關鍵字為最終的完成狀態 (有些文件說可以禁止派生與修改, 這可能嗎?). 使用範圍 class, function, var 等.
  • @filesource : 類似 example, 直接讀取當前解析的php文件的內容並顯示.
  • @global : 全局變量.
  • @ingore : 忽略指定的關鍵字.
  • @license : 標記授權 URL 與內容.
  • @link : 類似 @license, 作用就如 html 相似.
  • @name : 名稱註解.
  • @package :
  • @param : 函數的引數或參數說明.
  • @return : 返回值或狀態說明.
  • @see : 參考連結.
  • @since :
  • @static :
  • @staticvar : 靜態說明.
  • @subpackage :
  • @var datatype description : 變數與變數類型說明.
  • @todo information string [unspecified format] : 功能規劃性遞變說明.
  • @uses  file.ext|elementname|class::methodname()|class::$variablename|functionname()|function functionname description of how the element is used : 使用方式說明
  • @version : versionstring [unspecified format], 版本說明.

沒有留言:

張貼留言

Facebook