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');
        }
    };
});