JavaScript注释规范

你好,我是云桃桃。

一个希望帮助更多朋友快速入门 WEB 前端的程序媛。

云桃桃 ,大专生,一枚程序媛,感谢关注。回复 “前端基础题”,可免费获得前端基础 100 题汇总,回复 “前端基础路线”,可获取完整web基础路线导图。

308篇原创内容-更多前端系列内容可以go公众.h:云桃桃

后台回复“前端基础路线”可获取前端基础学习路线

后台回复“前端基础题”可得到前端基础100题汇总,持续更新中

后台回复“前端电子书”可获取20+本精选电子书

前言

在 JavaScript 中,注释就像是代码中的笔记,它可以帮助我们解释代码的功能、记录重要信息或者暂时禁用一段代码。

好,那我们一起来看看吧。

2 种注释的写法

以下是 JavaScript 中常见的注释方式:

  1. 单行注释:使用//开头,注释内容从//开始到本行结束。

  2. 多行注释:使用/*开头,*/结尾,注释内容可以跨越多行。

代码如下:

// 这是一个单行注释
let myVariable = 5/* 这是一个多行注释,用于解释下面的代码逻辑let myFunction = function() {console.log("Hello, World!");}
*/

要注意的是,多行注释不能嵌套多行注释,以下是一个错误的注释嵌套示例。

  /*这是一个/*注释这是一个嵌套的*/注释*/

在代码里也会有报错的提示,如图。

图片

注释的常见作用有以下 4 点:

  1. 解释代码:通过添加注释,可以让其他人更容易理解你的代码逻辑和意图。

// 这是一个计算圆的面积的函数
function calculateCircleArea(radius) {return Math.PI * radius * radius
}
  1. 记录重要信息:可以在注释中记录代码的版本、作者、日期等重要信息。

// 作者:桃
// 创建日期:2024-05-06
function myFunction() {// 这里实现了具体的功能
}
  1. 暂时禁用代码:在调试或测试代码时,可以使用注释暂时禁用一段代码,以便观察代码的执行效果。

// 注释掉这段代码,暂时禁用它
// console.log(name)
console.log(name + '测试测试666666')
  1. 提高代码的可读性:合理的注释可以使代码更加清晰,易于阅读和维护。

function myComplexFunction() {// 初始化变量let x = 0let y = 0// 执行复杂的计算逻辑// 返回计算结果return x + y
}

注释的 4 个注意点

  1. 注释应该与代码保持一致,当代码发生变化时,注释也应该相应地更新。

  2. 避免在注释中写下与代码无关的内容,以免干扰其他人对代码的理解。

  3. 对于复杂的代码块或函数,可以在注释中提供更多的解释和说明,帮助其他人更好地理解代码的结构和逻辑。

  4. 不要过度注释,应该只在必要的地方添加注释,以免影响代码的可读性。

OK,本文完。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/7082.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

8个细节决定你的活动策划推广成败-华媒舍

活动策划和推广对于一个成功的活动来说至关重要。许多因素会影响活动的成功与否,以下我将介绍8个关键细节,这些细节能够决定活动的策划与推广的成败。 1. 目标定位 活动策划必须明确目标。你需要确定你的活动是为了推广何种产品或服务,吸引什…

245 基于matlab的MEEMD信号分解及重构算法

基于matlab的MEEMD信号分解及重构算法。MEEMD方法的主要步骤包括:1. 定义多元信号集合,将多个信号进行集合;2. 对多元信号集合进行EEMD分解,得到一组IMFs;3. 将相同IMF进行平均,得到改进的IMFs;…

抖音小店如何快速出单?内行人闭口不提的诀窍,一篇全曝光!

哈喽~我是电商月月 新手做抖店不成功,最大的问题就是不懂技巧,不懂规则,不懂玩法,你基础事项,思维方向都没选好,再怎么努力也别想出单 看下去,新手在开店后不要着急选品,先把这些问…

AI热潮开始退去,财务压力迫使多家硅谷明星初创公司选择退出

曾风光无限的Stability AI已重组并削减业务规模,Inflection AI更是关闭业务并基本并入微软。 5月4日消息,国外媒体日前撰文指出,人工智能的热潮已开始逐渐褪去。初创公司想要同微软、谷歌等科技巨头在人工智能领域一决高下,门槛已…

供应链|经典论文解读:(s,S) 策略在动态库存下的最优性

文章考虑了具有订购成本(由单位成本加上重新订购成本组成)的动态库存问题。具体而言,对于每个时期,系统在中期开始是做出一系列采购决策——这些采购有助于库存的积累,并在随后的周期被需求所消耗。每时期系统会产生各…

04-18 周四 为LLM_inference项目配置GitHub CI过程记录

04-18 周四 为LLM_inference项目配置GitHub CI过程记录 时间版本修改人描述2024年4月18日10:30:13V0.1宋全恒新建文档 简介和相关文档 04-15 周一 GitHub仓库CI服务器配置过程文档actions-runner 是托管与GitHub上的仓库,下载最新的客户端程序即可。self hosted r…

一个年薪30w软件测试员的职业规划,献给还在迷茫中的朋友

先抛出一个观点 , 那些,担心30岁后,35岁后,40岁后,无路可走的;基本属于能力不够、或者思维太局限 。 总之,瞎担心 / 不长进 。 具体,见下面正文 。 曾经,在16年&#xff…

AI技术赋能下的视频监控方案是如何解决新能源汽车充电难问题的?

一、方案背景 刚刚结束的第十八届北京车展异常火爆,其中一组与汽车有关的数字让人格外关注。根据乘联会2024年4月19日公布的最新数据,全国乘用车市场零售达到51.6万辆,其中新能源车的销量约为26万辆,市场渗透率达到50.39%。 这意味…

音视频开发4 FFmpeg windows 环境搭建,QT 安装,动态库的搜索路径

FFmpeg 为了让所有平台的开发者都能够学习到音视频开发的通用技术,本教程主要讲解跨平台的音视频开发库FFmpeg。其实只要你掌握了FFmpeg,也可以很快上手其他音视频开发库,因为底层原理都是一样的,你最终操作的都是一样的数据&…

【第10章】spring-mvc转发和重定向

文章目录 前言一、准备二、转发1. 视图解析器(推荐)2. 关键字(forward)3. request 三、重定向1.关键字(redirect)2. HttpServletResponse 四、区别总结 前言 前面介绍了视图解析器的使用,但是对我们原有转发和重定向有影响,接下来我们通过案例,来使用学习转发和重定向的用法。…

ComfyUI 基础教程(十四):ComfyUI中4种实现局部重绘方法

在ComfyUI中有多种方式可以实现局部重绘,简单的方式是使用VAE内补编码器进行局部重绘,也可以用Fooocus inpaint进行局部重绘,还可以用controlNet的inpaint模型进行局部重绘,以及使用Clip seg蒙版插件! 本篇介绍使用VAE內补编码器进行局部重绘的方法。 1、VAE内补编码器 局…

《架构风清扬-Java面试系列第28讲》聊聊SynchronousQueue的使用及适合场景

SynchronousQueue是BlockingQueue接口的一个实现类之一 这个属于基础性问题,老规矩,我们将从使用场景和代码示例来进行讲解 来,思考片刻,给出你的答案 1,使用场景 实现:特殊的无缓冲队列,每一个…

帆软报表9.0连接达梦数据库

一、将驱动复制到帆软安装目录下 二、配置数据库连接 注意:dm.jdbc.driver.DmDriver是直接在文本框输入的 进行以上两部就能连接达梦数据库了

揭秘!如何利用自动化工具提升抖音推广效果

亲爱的读者朋友们,你是否在为抖音的推广效果而苦恼?看着别人家的视频轻松获得大量曝光,你是否也心生羡慕?今天,我们就来分享一个秘密武器,让你轻松提升抖音推广效果! 首先,让我们来了…

开发环境待

一 web开发环境搭建 1 web开发环境概述 所谓web开发,指的就是从网页中向后端程序发送请求.与后端程序进行交互. 流程图: 1,Web服务器是指驻留于因特网上某种类型计算机的程序. 2, 可以向浏览器等Web客户端提供文档,也可以放置网站文件,让全世界 浏览…

微信答题活动怎么做_智慧与惊喜的碰撞

在这个信息爆炸的时代,如何吸引用户的眼球,让他们在众多品牌中驻足停留?答案或许就藏在一次别开生面的微信答题活动中。今天,就让我们一起走进这场以智慧与惊喜为主题的微信答题狂欢夜,感受其带来的独特魅力。 工具/原…

AI预测福彩3D第10套算法实战化赚米验证第2弹2024年5月6日第2次测试

由于今天白天事情比较多,回来比较晚了,趁着还未开奖,赶紧把预测结果发出来吧~今天是第2次测试~ 2024年5月6日福彩3D预测结果 6-7码定位方案如下: 百位:3、4、1、7、8、9 十位:4、5、3、7、8、9 个位&#x…

JS基础:输出信息的5种方式详解

你好,我是云桃桃。 一个希望帮助更多朋友快速入门 WEB 前端的程序媛。 云桃桃-大专生,一枚程序媛,感谢关注。回复 “前端基础题”,可免费获得前端基础 100 题汇总,回复 “前端基础路线”,可获取完整web基础…

python3+requests+unittest实战系列【一】

1.环境准备 python3 pycharm编辑器 2.框架目录展示 (该套代码只是简单入门,有兴趣的可以不断后期完善) 1)run.py主运行文件,运行之后可以生成相应的测试报告,并以邮件形式发送; &#xff0…

【电商-虾皮】

电商-虾皮 ■ 人口分布■ 市场■ 欧美市场■ 东南亚市场■ 运营模式■ 流量来源■ ERP辅助软件■■ 选品方法■■■ 人口分布 ■ 市场 ■ 欧美市场 亚马逊 ■ 东南亚市场 shopee ■ 运营模式 ■ 流量来源