js函数注释规范

最新推荐文章于 2026-06-20 15:25:20 发布
原创 最新推荐文章于 2026-06-20 15:25:20 发布 · 2.4w 阅读 · 10 ·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
收录于
原生js

当前文章被收录于：

原生js
165 篇文章 0 人学习
订阅专栏 查看详情
本文探讨了代码注释的重要性，强调其对于程序维护和个人合作的价值，并介绍了一种规范化的注释方法，有助于提升代码的可读性和可维护性。

之前，写代码的时候都是很简单的一种注释，或者有些压根没有注释。注释是代码的一部分，一个完整的程序必须有注释。这样不仅方便自己更新和维护项目，更有利于日后他人 接手你的项目时可以快速知道你写的是什么。
下面我们看一下代码注释的魅力所在。
@methed 声明函数或类方法，用法

/*方法说明
 *@method 方法名
 *@for 所属类名
 *@param{参数类型}参数名 参数说明
 *@return {返回值类型} 返回值说明
*/
标签
#js注释
I-Cache 和 D-Cache
liuyuanbin9001
02-22 6961
I-Cache 和 D-Cache
优雅的JavaScript注释规范
CodeRoarX的博客
10-03 243
注释是代码的重要组成部分，它们可以提高代码的可读性、可维护性和可协作性。JavaScript注释是开发过程中重要的组成部分，可以提供代码的解释、文档化和协作。本文将介绍一些关于JavaScript注释的规范，并提供一些示例代码来说明。在JavaScript文件的开头，使用多行注释来提供文件的描述、作者、创建日期等信息。注：本文只是提供一种注释规范的示例，实际项目中可以根据团队的需求和偏好来制定自己的注释规范。在函数定义之前，使用多行注释来提供函数的描述、参数和返回值的说明。）开头，以星号斜杠（
JS method请求方式的应用
TianXuab的博客
08-09 722
类似地，你可以使用相应的请求方式来执行其他操作，例如使用 PUT 请求来更新资源，使用 DELETE 请求来删除资源。这些示例展示了使用不同请求方式从服务器获取数据或向服务器发送数据的方法。在现代开发中，通常推荐使用。这些请求方式用于从服务器获取数据或向服务器发送数据。它通常用于获取资源，不会对服务器上的数据进行修改。POST 请求用于向服务器提交数据。它通常用于创建资源或在服务器上执行操作。JavaScript 中的网络请求方式通常是通过浏览器提供的。，它提供了更简洁、灵活和现代化的方式来处理网络请求。
DBC中如何实现报文传输类型属性的配置
sunchengl的博客
09-25 267
AUTOSAR中CAN报文的传输类型主要有三种，周期型，事件型和混合型。周期型：按固定时间间隔自动发送，无需额外的触发条件。事件型：当信号值变化或满足内部条件时立即发送。混合型：默认按周期发送，但事件触发时可提前发送。
规范JavaScript注释
小康博客
06-25 1万+
行内注释 显示一个解释的评论 // 用来显示一个解释的评论 显示表达式的结果 // -> 用来显示表达式的结果 显示 console 的输出结果 // >用来显示 console 的输出结果 示例 function test() { // 测试函数 console.log('Hello World!'); // >Hello World! return 3 + 2; // ->5 } //(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字
05-代码书写规范：注释、命名与代码风格
最新发布
以梦想为帆，行动作桨，驶向辉煌彼岸。
06-20 197
写代码就像写文章，不仅要让机器能运行，还要让人能读懂。良好的代码规范是团队协作的基础，也是你编程素养的体现。本章介绍的规范，将伴随你整个编程生涯。
JS | 如何规范 JavaScript 的注释
青春木鱼的博客
11-06 2146
规范JavaScript的注释方法包括使用单行注释、多行注释、使用JSDoc风格的注释以及采用一致的注释习惯。其中，使用JSDoc风格的注释是为了提高代码的可读性和维护性，通过在函数和变量声明之前添加规范化的注释，为代码的每一部分提供清晰的文档说明。这种做法不仅有助于团队成员之间的沟通，也便于未来的代码维护和更新。
函数 注释规范_javascript命名规范
weixin_36411280的博客
01-11 1040
js命名应遵循 简洁、语义化 的原则一、变量命名方法: 小驼峰式命名法 命名规范：前缀为形容词 （函数前缀为动词, 以此来区分函数和变量）# 好的命名方式 let maxCount = 10; let tableTitle = '啦啦啦'; # 不好的命名方式 let setConut = 10; let getTitle = '啦啦啦';二、常量命名方法：名词全部大写 命名规范：使用大写字母和下...
js去掉前后空格的函数_js/javascript代码注释规范与示例
weixin_39610774的博客
11-03 136
注释在代码编写过程中的重要性，写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习，同时为了自己以后对代码进行‘升级’，看看js/javascript代码注释规范与示例。来自：http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html文件注释文件注释位于文件的最前面，应包括文件的以下信息...
JS TS 给函数注释的规范
weixin_43416349的博客
02-09 2257
前言： 使用这种注释方法，在其他地方调用这个函数，鼠标停在这个函数上面时，就是显示这些注释，是一种 十分必要的 规范。使用 Alt + Shift + A 可以快速生成 /**/ ,最好是自己配置 Snippet。
每周总结 函数方法注释规范/jQuery深拷贝/js补全函数/Vue文档学习
RobinZZX的博客
08-08 260
js代码规范 注释规范 函数说明注释：在函数声明上方键入 /** ,再按回车键： /** * @function 处理表格的行 * @description 合并Grid的行 * @param grid {Ext.Grid.Panel} 需要合并的Grid * @param cols {Array} 需要合并列的Index(序号)数组；从0开始计数，序号也包含。 * @param isAllSome {Boolean} ：是否2个tr的cols必须完成一样才能进行合并。true：完成一样；false(默认)
函数 注释规范_十二个栗子对js注释规范进行总结
weixin_36052776的博客
01-08 529
一个优秀的程序员，必然有一个良好的代码写作习惯。希望大家都能养成好习惯！.如果看一个项目的代码没有任何注释规范，导致代码里很少有注释，或者注释写的很简练，那是一件多么让人难受的事情呀。好的规范规则让人舒服以科学伦理学为例Science Ethics as an Illustration今天就对js注释规范进行总结：本文js注释规范基于jsdoc，写出的代码注释能够成功生成注释文档。命令名描述@pa...
7天从零到精通：开源OCR工具的颠覆性工作流改造
gitblog_00025的博客
06-03 460
你是否曾在整理纸质文档时，面对堆积如山的扫描件感到无从下手？是否在阅读外文资料时，渴望一个能离线识别文字的得力助手？Umi-OCR，这款开源免费的离线OCR软件，正在悄然改变着无数人的数字办公体验。它支持截屏识别、批量图片处理、PDF文档OCR、二维码扫描与生成，更重要的是，所有操作都在本地完成，无需网络连接，保障了数据的安全隐私。 ## 发现之旅：从繁琐到高效的蜕变 想象一下这样的场景：作为
js 多行注释函数注释一般规范写法
J_1999_0524的博客
01-03 1118
【代码】js 多行注释函数注释一般规范写法。
如何编写清晰的js-cookie代码注释：完整规范指南
gitblog_00585的博客
03-17 563
在JavaScript开发中，良好的代码注释是提升代码可读性和可维护性的关键。对于轻量级浏览器Cookie处理库js-cookie而言，规范的注释不仅帮助团队协作，还能让新开发者快速理解核心功能。本文将详细解析js-cookie项目的代码注释规范，带你掌握编写专业注释的实用技巧。 ## 单行注释：简洁说明代码意图 js-cookie项目中最常用的注释方式是单行注释，以`//`开头，用于解释单行
JavaScript之注释规范化（JSDoc）
热门推荐
knight-yun的博客
03-13 1万+
介绍JavaScript中的一种规范化注释格式
js中函数(方法)注释
u012338130的专栏
03-04 6301
什么时候对函数进行注释 不一定说任何函数方法都必须使用JSDoc，但是有一点要注意如果是自己封装的方法，有必要使用JSDoc，理由是可以让其他成员更容易的去了解你封装的方法的属性或返回值，这样可以降低维护成本和提高开发效率。 编码实战 说明：函数(方法)注释也是多行注释的一种，但是包含了特殊的注释要求，参照JSDoc 语法： /** * 函数说明 * @关键字 */ 常用注释关键字：(只列出一部分，并不是全部) 注释名 语法 含义 示例 @f...
JavaScript 开发规范（一）： 命名与注释规范详解
Aays2790的博客
07-19 638
ECMAScript 规范中标识符采用驼峰大小写格式，驼峰命名法由小(大)写字母开始，后续每个单词首字母都大写。从事前端开发也有一段时间了，一直在遵循着规范化开发，从 js 也逐渐转向了 ts ，在这个过程中也有了很多收获，在此把自己的开发心得写下来。命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；Camel Case 小驼峰式命名法：首字母小写。本文参考了JavaScript 开发规范，并做了补充和修改，同时删去了框架开发相关的内容(侵删)。命名方法：小驼峰式命名法。
weex和Android的交互
hellenicguo的专栏
03-01 7031
项目需求用weex开发，所以写下希望对需要的人有所帮助吧 weex调用native的方法时 @JSMethod(uiThread = true) public void printLog(String msg) { WXLogUtils.d("打印日志",msg); } native传递参数给weex时 @JSMethod(uiThr
（8）vue.js基础语法—methods选项
Java田根旺
01-25 2365
​ 一、methods选项介绍 • 用于存储需要在 Vue 实例中使用的函数。 二、methods选项示例 没有使用methods选项的情况下，我们只能再插值表达式当中进行书写逻辑代码，这并不符合我们的开发规范，我们的规范是将视图和逻辑进行分离书写 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta
华为HCIP-Transmission V2.0 LVC公开课培训视频教程【共64集】.rar
目录：网盘文件永久链接第一章 NG WDM系统硬件 1.1_NG WDM系统硬件 (1) 1.2_NG WDM系统硬件 (2) 1.3_NG WDM系统硬件 (3) 第二章 NG WDM设备组网与应用 2.1_网络层次和系统架构 2.2_站点类型 2.3_站点应用场景和组网基本要素 第三章 NG WDM光电层调度方案 3.1_NG WDM光层调度方案 3.2_NG WDM电层调度方案 第四章 NG WDM通用数据配置 4.1_配置前准备 4.2_创建并配置网元和网络 4.3_备份网元数据库 第五章 NG WDM光层业务配置 5.1_WDM光层数据配置 第六章 NG WDM电层业务配置 6.1_NG-WDM电层业务配置 第七章 NG WDM系统调测 7.1_调测前准备 7.2_非相干系统调测 7.3_相干系统光功率调测、混传系统光功率调测与系统调测 第八章 NG WDM系统常用指标测试 8.1_NG WDM 系统常用指标测试 第九章 NG WDM设备保护 9.1_设备保护，光层保护 - 光线路保护 9.2_光层保护 - 板内1+1，客户侧1+1与电层保护 第十章 NG WDM设备日常维护 10.1_设备侧日常维护 10.2_网管侧日常维护 第十一章 NG WDM告警信号流 11.1_概述与光层告警分析 11.2_电层告警分析 第十二章 NG WDM 系统故障处理 12.1_故障处理准备与故障定位思路 12.2_常见故障分析与故障案例 第十三章 SOM智慧光管系统专题 13.1_SOM系统介绍 13.2_SOM系统原理 13.3_SOM系统配置与操作 第十四章 智能光纤管理系统专题 14.1_智能光纤管理系统介绍 14.2_线路光纤质量监测原理 14.3_光纤质量检测功能的使用 第十五章 NG WDM 分组技术简介 15.1_IP概述 15.2_MPLS技术 15.3_PWE3技术 15.4_MPLS-TP技术 第十六章 MS-OTN 组网与业务介绍 16.1_网络应用 16.2_业务介绍 16.3_网络保护 第十七章 OptiX OSN 1800V 分组业务配置 17.1_Optix OSN 1800V分组业务配置 第十八章 新技术专题 18.1_新技术专题 第十九章 MSTP技术专题-时钟保护 19.1_时钟保护的基本概念与标准SSM时钟保护协议 19.2_扩展SSM时钟保护协议 第二十章 MSTP技术专题-ECC维护、指针调整 20.1_MSTP技术专题-ECC维护、指针调整 第二十一章 MSTP技术专题-PCM技术 21.1_PCM技术原理与应用 21.2_PCM单板 第二十二章 MSTP单板更替换 22.1_单板更替换概述 22.2更换故障单板 22.3_单板兼容替代 22.4_单板容量升级 第二十三章 离散业务分析与处理 23.1_离散业务的基本概念 23.2_ 离散业务产生的原因和处理方法 23.3_离散业务的清理步骤 23.4_如何避免产生离散业务 第二十四章 以太网业务常见指标测试 24.1_以太网基本概念 24.2_以太网性能测试简介 24.3_以太网业务常见测试指标 24.4_以太网业务常见指标测试步骤 第二十五章 MSTP设备故障处理 25.1_故障定位准备 25.2_故障定位方法 25.3_故障案例分析 第二十六章 ASON智能光网络 26.1_ASON介绍与基本功能 26.2_ASON功能特性(1) 26.3_ASON功能特性(2) 26.4_2M ASON介绍
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值