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'); } }; });
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· Linux glibc自带哈希表的用例及性能测试
· 深入理解 Mybatis 分库分表执行原理
· 如何打造一个高并发系统?
· .NET Core GC压缩(compact_phase)底层原理浅谈
· 现代计算机视觉入门之:什么是图片特征编码
· 手把手教你在本地部署DeepSeek R1,搭建web-ui ,建议收藏!
· Spring AI + Ollama 实现 deepseek-r1 的API服务和调用
· 数据库服务器 SQL Server 版本升级公告
· 程序员常用高效实用工具推荐,办公效率提升利器!
· C#/.NET/.NET Core技术前沿周刊 | 第 23 期(2025年1.20-1.26)