注释名语法含义 @function @function 简要描述 用于定义当前对象是一个函数,后面可跟描述 @description @description 描述信息 用于描述 @param @param {参数类型} 参数名 - 描述信息 描述参数的信息 @return @return {返回类型} 描述信息 描述返回值的信息 @author @author 作者信息 [附属信息:如邮箱、日期] 描述...
1、egg.js 的注释风格 从图中可以看到 egg.js 的入口文件的注释特点是简单整洁。 继续看下图: 这是一个被抽象出来的基类,展示了作者 [Yiyu He] 当时写这个类的时候,其注释的风格有以下几点: 第一点:构造函数的注释规则,表达式语句的注释规则。 第二点:注释的取舍,有一些变量可以不用注释,有些要注释,不要...
一、js 函数注释可以采用 JSDoc 标准,格式如下: /** * 函数功能描述 * * @param {参数类型} 参数名称 - 参数描述 * @return {返回值类型} 返回值描述 */functionfunctionName(parameter){// 函数体} 二、可能你的参数需要支持过多类型,可以使用 | 符合进行分割: /** * 对字符串或数字进行加密 * * ...
js函数注释规范 js函数注释规范 常⽤符号说明⽤法 @param参数@param {type} name @return返回值@return {type} /** * 测试 * @param {number} num * @return {void} */ function test(num) { console.log(num);} /** * Enqueue a callback that will be executed after all the pending updates...
JS函数注释是提高代码可读性和可维护性的重要手段,以下是JS函数注释的标准格式: /** * @desc函数描述 * @param {参数类型}参数名参数描述 * @return {返回值类型}返回值描述 */ 其中,@desc表示函数的描述;@param表示函数的参数描述;@return表示函数的返回值描述。 示例: /** * @desc计算两个数的和 * ...
js中函数(方法)注释 原文链接:https://blog.csdn.net/tianxintiandisheng/article/details/103764074 实例 /*** @function 处理表格的行 *@description 合并Grid的行* @param grid {Ext.Grid.Panel} 需要合并的Grid *@param cols {Array} 需要合并列的Index(序号)数组;从0开始计数,序号也包含。* @param is...
最近在复习面试中常见的JS手写函数,顺便进行代码注释和总结,方便自己回顾也加深记,内容也会陆陆续续进行补充和改善。 一、手写深拷贝 const obj1={ name:'Leise', age:23, address: { country:'China', city:'Guanzhou'} } const obj2=deepClone(obj1) obj2.address...
在JavaScript编程中，函数注释扮演着关键的角色。它就像是代码的说明书，清晰地揭示了函数的用途和工作方式。通过添加注释，开发者可以明确地标识函数接受的参数类型，以及返回值的预期结果。这样的标注不仅有助于提升团队协作的效率，减少维护代码时的困惑，还能让新接手项目的开发者快速上手，从而节省时间和...
js代码规范 注释规范 函数说明注释:在函数声明上方键入 /** ,再按回车键: /** * @function 处理表格的行 * @description 合并Grid的行 * @param grid {Ext.Grid.Panel} 需要合并的Grid * @param cols {Array} 需要合并列的Index(序号)数组;从0开始计数,序号也包含。
js中函数(方法)注释 简介:不一定说任何函数方法都必须使用JSDoc,但是有一点要注意如果是自己封装的方法,有必要使用JSDoc,理由是可以让其他成员更容易的去了解你封装的方法的属性或返回值,这样可以降低维护成本和提高开发效率。 什么时候对函数进行注释 不一定说任何函数方法都必须使用JSDoc,但是有一点要注意如果是自己...