javascript註釋規範

題引：

　　做爲專業的js開發工程師，註釋規範與否相當重要，下面推薦一下我的總結的javascript註釋模板，採用jsDoc規範；

正文：

　　在一個文件中註釋大概分三類：文檔註釋、函數（類）註釋、（變量）常量註釋

　　文檔註釋：告知他人該js文件主要處理的核心內容；

　　函數（類）註釋：告知他人該函數（類）的參數、功能、對外接口等；

　　變量（常量）：變量的特殊意義，普通變量能夠不作註釋

舉例：

　　文檔註釋：　　　　

 /**
* @ignore  =====================================================================================
* @fileoverview 該文檔主要完成主要任務是……
* @author  abcdefg@163.com
* @version 1.0.0
* @ignore  created in 2013-10-11
* @ignore  depend Library jQuery
* @ignore  =====================================================================================
*/

　　函數(類)規範：

　　　

/**
    * 數據格式化
    * @param src {Array}        長度自由的一維數組，子元素爲json對象
    * @param data {Object}         參考數據
    * @ignore created             2013-10-11
    * @return result {Array}    返回格式化後與src類型相同的數組
    */

　　變量（常量）規範：

var type='ast';//記錄編輯類型

 

完整版：

　　

 /**
* @ignore  =====================================================================================
* @fileoverview 該文檔主要完成主要任務是……
* @author  abcdefg@163.com
* @version 1.0.0
* @ignore  created in 2013-10-11
* @ignore  depend Library jQuery
* @ignore  =====================================================================================
*/

define(function(require, exports, module) {
    var j=require('gallery/jquery/jquery/dist/jquery');  
    
    /**
    * 數據格式化
    * @param src {Array}        長度自由的一維數組，子元素爲json對象
    * @param data {Object}      參考數據
    * @ignore created           2013-10-11
    * @return result {Array}    返回格式化後與src類型相同的數組
    */
    var test=function(src,data){
        var type='ast';//記錄編輯類型
        retrun [];
    };
    
    module.exports = {
        init: function() {
            console.log(true);
        },
        show:function(){
            console.warn('true');
        }
    };
});