JSDoc 註釋規範

命令名描述

@param @argument 指定參數名和說明來描述一個函數參數
@returns 描述函數的返回值
@author 指示代碼的做者
@deprecated 指示一個函數已經廢棄，並且在未來的代碼版本中將完全刪除。要避免使用這段代碼
@see 建立一個HTML連接，指向指定類的描述
@version 指定發佈版本
@requires 建立一個HTML連接，指向這個類所需的指定類
@throws @exception 描述函數可能拋出的異常的類型
{@link} 建立一個HTML連接，指向指定的類。這與@see很相似，但{@link}能嵌在註釋文本中
@fileoverview 這是一個特殊的標記。若是在文件的第一個文檔塊中使用這個標記，則指定該文檔塊的餘下部分將用來提供這個文件的概述
@class 提供類的有關信息，用在構造函數的文檔中
@constructor 明確一個函數是某個類的構造函數
@type 指定函數的返回類型
@extends 指示一個類派生了另外一個類。JSDoc一般本身就能夠檢測出這種信息，不過，在某些狀況下則必須使用這個標記
@private 指示一個類或函數是私有的。私有類和函數不會出如今HTML文檔中，除非運行JSDoc時提供了–private命令行選項
@final 指示一個值是常量值。要記住JavaScript沒法真正保證一個值是常量
@ignore JSDoc忽略有這個標記的函數

例子1：

/**
* @fileOverview 簡單的方法標註示例
* @author <a href=」llying.javaeye.com」>llying</a>
* @version 0.1
*/

/**
* @description 加法運算
* @param {Num} num1 加數
* @param {Num} num2 被加數
* @return {Num} result 結果
*/
function add(num1,num2){
    return num1 + num2;
}

/**
* @description 減法運算
* @param {Num} num1 減數
* @param {Num} num2 被減數
* @return {Num} result 結果
*/
function minus(num1,num2){
    return num1 – num2;
}

例子2：

/**
* @fileOverview 簡單的類對象標註示例
* @author <a href=」llying.javaeye.com」>llying</a>
* @version 0.1
*/

/**
* @author llying
* @constructor Person
* @description 一個Person類
* @see The <a href=」#」>llying</a >.
* @example new Parent(「張三」,15);
* @since version 0.1
* @param {String} username 姓名
* @param {Num} age 年齡
*/
function Person(username,age)
{
    /**
    * @description {Sting} 姓名
    * @field
    */
    this.username = username;
    
    /**
    * @description {Num} 年齡
    * @field
    */
    this.age = age;
    
    /**
    * @description 彈出say內容
    * @param {String} content 內容
    */
    this.say = function(content)
    {
        alert(this.username+」 say :」+content);
    }
    
    /**
    * @description 返回json格式的對象
    * @return {String} json格式
    * @see Person#say
    */
    this.getJson = function(){
        return 「{name:」+this.username+」,age」+this.age+」}」;
    }
}