什么是JSDocJSDoc是一个根据JavaScript文件中的注释信息生成JavaScript应用程序或模块的API文档的工具。可以使用JSDoc标签，如：命名空间、类、方法、方法参数等。使开发者可以轻松阅读代码，掌握代码定义的类及其属性和方法，从而降低维护成本，提高开发效率。什么时候对函数进行注解并不一定意味着任何函数方法都必须使用JSDoc，但是需要注意的一点是，如果是自封装的方法，就一定要使用JSDoc，原因是它可以更方便的调用其他成员了解你封装的方法属性或返回值，可以降低维护成本，提高开发效率。编码实用说明：函数（方法）注释也是多行注释的一种，但是包含了特殊的注释要求，参考JSDoc语法：/***函数说明*@keyword*/常用注释关键字：（仅列出部分,不是全部)注释名语法含义示例@function@function一个简短的描述，用于定义当前对象是一个函数，后面可以跟一个描述@function来处理表的行@description@description描述信息用于描述@descriptionMergeGridLine@param@param参数名{参数类型}描述信息描述参数信息@paramname{String}传入名称@return@return{returntype}描述信息描述返回值信息@return{Boolean}true:可执行;false:不可执行@author@author作者信息[辅助信息：如email地址，日期]描述该函数的作者信息@作者张三2015/07/21@version@versionXX.XX.XX描述了该函数的版本号@version1.0.3@example@example示例代码演示函数的使用@examplesetTitle('test')/***@functionprocessingtablerows*@descriptionmergingGridrows*@paramgrid{Ext.Grid.Panel}要合并的Grid*@paramcols{Array}要合并的列的Index（序号）数组;从0开始计数，也包括序号。*@paramisAllSome{Boolean}:2个tr的cols是否必须相同才可以合并。true：完成相同；false（默认）：不完全一样年龄|姓名||年龄|名称|*----------------mergeCells(grid,[0])--------------*|18|张三|=>||张三|*-------------------18----------*|18|王五|||五王|*------------------------------*/functionmergeCells(grid:Ext.Grid.Panel,cols:Number[],isAllSome:boolean=false){//DoSomething}这里只是详细解释了js中的函数（方法）注解，还有很多规范没来得及填写。可以参考AirbnbJavaScriptStyleGuideparameterpassingincallbackfunction/***这个回调类型叫做`requestCallback`并且显示为全局符号。**@callbackrequestCallback*@param{number}responseCode*@param{string}responseMessage*//***异步执行某些操作并在完成时执行回调。*@param{requestCallback}cb-处理响应的回调。*/functiondoSomethingAsynchronously(cb){//代码};参考JSDoc中文文档
