js中函数（⽅法）注释
什么时候对函数进⾏注释
不⼀定说任何函数⽅法都必须使⽤JSDoc，但是有⼀点要注意如果是⾃⼰封装的⽅法，有必要使⽤JSDoc，理由是可以让其他成员更容易的去了解你封装的⽅法的属性或返回值，这样可以降低维护成本和提⾼开发效率。
编码实战
说明：函数(⽅法)注释也是多⾏注释的⼀种，但是包含了特殊的注释要求，参照
语法：
/**
* 函数说明
* @关键字
*/
常⽤注释关键字：(只列出⼀部分，并不是全部)
注释名语法含义⽰例
@function@function 简要描述⽤于定义当前对象是⼀个函数，后⾯可跟
描述
@function 处理表格的⾏
@description@description 描述信息⽤于描述@description 合并Grid的⾏@param@param 参数名 {参数类型} 描述信息描述参数的信息@param name {String} 传⼊名称
@return@return {返回类型} 描述信息描述返回值的信息@return {Boolean} true：可执⾏;false：不可
执⾏
@author @author 作者信息 [附属信息：如邮箱、⽇
期]
描述此函数作者的信息@author 张三 2015/07/21
@version@version XX.XX.XX描述此函数的版本号@version 1.0.3 @example@example ⽰例代码演⽰函数的使⽤@example setTitle(‘测试’) /**
* @function 处理表格的⾏
* @description 合并Grid的⾏
* @param grid {Ext.Grid.Panel} 需要合并的Grid
* @param cols {Array} 需要合并列的Index(序号)数组；从0开始计数，序号也包含。
* @param isAllSome {Boolean} ：是否2个tr的cols必须完成⼀样才能进⾏合并。true：完成⼀样；false(默认)：不完全⼀样
* @return void
* @author polk6 2015/07/21
* @example
* _________________ _________________
* | 年龄 | 姓名 | | 年龄 | 姓名 |
* ----------------- mergeCells(grid,[0]) -----------------
* | 18 | 张三 | => | | 张三 |
* ----------------- - 18 ---------
* | 18 | 王五 | | | 王五 |
* ----------------- -----------------
*/javascript说明
function mergeCells(grid: Ext.Grid.Panel, cols: Number[], isAllSome: boolean =false){
// Do Something
}
这⾥只是详细讲解了 js中函数(⽅法)注释，还有很多其它的规范没来得及填充，可以参考⼀下
参数传⼊回调函数
/**
* This callback type is called `requestCallback` and is displayed as a global symbol. *
* @callback requestCallback
* @param {number} responseCode
* @param {string} responseMessage
*/
/**
* Does something asynchronously and executes the callback on completion.
* @param {requestCallback} cb - The callback that handles the response.
*/
function doSomethingAsynchronously(cb){
// code
};
参考资料

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。