jsDoc注釋的規範

標籤：c   class   java   a   ext   檔案   

注釋以/**  開始     */結束

JSDoc 命令屬性

　　命令名 描述 

　　@param

　　@argument 指定參數名和說明來描述一個函數參數。 

　　@return

　　@returns 描述函數的傳回值。 

　　@author 指示代碼的作者。 

　　@see 建立一個HTML連結指向指定類的描述。 

　　@version 指定發布版本。 

　　@requires 建立一個HTML連結，指向這個類所需的指定類。 

　　@throws

　　@exception 描述函數可能拋出的異常的類型。 

　　{@link} 建立一個HTML連結，指向指定的類。這與@see很類似，但{@link}能嵌在注釋文本中。 

　　@author 指示代碼的作者。（譯者註：這個標記前面已經出現過，建議去掉） 

　　@fileoverview 這是一個特殊的標記，如果在檔案的第一個文檔塊中使用這個標記，則指定該文檔塊的餘下部分將用來提供檔案的一個概述。 

　　@class 提供類的有關資訊，用在建構函式的文檔中。 

　　@constructor 明確一個函數是某個類的建構函式。 

　　@type 指定函數的傳回型別。 

　　@extends 指示一個類派生了另一個類。通常JSDoc自己就可以檢測出這種資訊，不過，在某些情況下則必須使用這個標記。 

　　@private 指示一個類或函數是私人的。私人類和函數不會出現在HTML文檔中，除非運行JSDoc時提供了—private命令列選項。 

　　@final 指示一個值是常量值。要記住JavaScript無法真正保證一個值是常量。 

　　@ignore JSDoc 會忽略有這個標記的函數。