JavaScript注释:单行注释和多行注释详解

开发者福利!热门AI工具限时免费用 购周边即赠Coding Plan Lite,Claude Code、Cursor等20+工具畅享,效率翻倍! 阅读详情

为了提高代码的可读性,JS与CSS一样,也提供了注释功能。JS中的注释主要有两种,分别是单行注释和多行注释。

在编程的世界里,注释是那些默默无闻的英雄,它们静静地站在代码的背后,为后来的维护者、为未来的自己,甚至是为那些偶然间翻阅你代码的开发者提供着不可或缺的信息。

在这里插入图片描述

今天,我们就来深入探讨JavaScript中的注释,让我们的代码不仅能够运行,还能够“说话”。

一、什么是JavaScript注释

JavaScript注释是用来解释代码的,不会被浏览器执行。它们可以帮助其他开发者理解代码的功能和目的。

注释就像是给代码穿上了一件华丽的外衣,让我们的代码更加优雅、易读。如下图中的例子所示:
Description

在JavaScript中,有两种类型的注释:单行注释和多行注释。下面分别讲解这两种注释的含义和使用。

二、JavaScript注释的种类

1、单行注释

单行注释: 使用两个斜杠(//)开头,后面的内容直到该行结束都被视为注释。例如:

// 这是一个单行注释
console.log("Hello, World!"); // 这也是一个单行注释

它适用于简短的注释,比如对某一行代码的快速说明。

2、多行注释

多行注释: 使用斜杠星号(/)开头,星号斜杠(/)结尾,中间的内容都被视为注释。

例如:

/*
这是一个多行注释
可以跨越多行
*/
console.log("Hello, World!");

这种注释可以跨越多行,适合用于函数描述、复杂的算法解释或者临时屏蔽代码块。

注意: 在HTML文件中,如果需要将JavaScript代码嵌入到

<script>
<!--
这是一个多行注释
可以跨越多行
-->
console.log("Hello, World!");
</script>

三、JavaScript注释的作用

1、解释代码功能:

通过注释,我们可以解释代码的功能和作用,让其他程序员更容易理解我们的代码。

// 这是一个求和函数
function sum(a, b) {
  return a + b;
}

2、 标记代码状态:

我们可以使用注释来标记代码的状态,例如TODO、FIXME等,提醒自己或其他程序员注意这些问题。

// TODO: 优化这个函数的性能
function slowFunction() {
  // ...
}

3、临时禁用代码:

当我们需要暂时禁用某段代码时,可以使用注释将其包裹起来,而不是直接删除。

// function oldFunction() {
//   // ...
// }

想要快速入门前端开发吗?推荐一个前端开发基础课程,这个老师讲的特别好,零基础学习无压力,知识点结合代码,边学边练,可以免费试看试学,还有各种辅助工具和资料,非常适合新手!点这里前往学习哦!

四、如何写好注释

注释虽好,但过多或不当的注释反而会成为阅读代码的障碍。我们在写注释时也要注意以下几点:

  • 简洁明了: 注释应该简单明了,能够快速传达信息。

  • 适当使用: 不要过度使用注释,只有在必要的时候才添加。

  • 保持一致: 在团队开发中,要遵循统一的注释规范,以便于团队成员之间的沟通。

  • 适时更新: 随着代码的变更,记得更新相关的注释。

JavaScript注释是我们编程过程中的得力助手,它们不仅能够帮助我们更好地理解代码,还能提高代码的可读性和可维护性。让我们一起学会使用注释,让我们的代码更加精彩!

一文读懂Cache一致性原理 本文介绍了为什么需要维护cache一致性、一致性协议的本质类别,以及如何设计一致性协议。 阅读详情

相关推荐

推荐系统(1):推荐系统评测

对于可以离线优化的指标,我个人的看法是应该在给定覆盖率、多样性、新颖性等限制条件下,尽量优化预测准确度。用一个数学公式表达,离线实验的优化目标是:最大化预测准确度使得 覆盖率 > A多样性 > B新颖性 > C其中,A、B、C的取值应该视不同的应用而定。

数据不会骗人 2494

react学习 ---第三天

1 认识JSX语法 2 JSX的基本使用 3 JSX的事件绑定 4 JSX的条件渲染 5 JSX的列表渲染 6 JSX的原理本质

weixin_56663198的博客 1415

Android Display Graphics #1 整体框架介绍一

手机屏上显示的内容,2D或3D ,如果是 3D 的,不管是 App 还是游戏,或者简单的图片界面,底层都是通过 GPU、 通过 OpenGL(ES)绘制出来的。是Java层的一个类,提供了一系列API,使用这些API可以实现各种的产品经理要求的效果。显示的不同阶段对这块内存的叫法不同,在上层可以是Window、ANnativeWindow、Surface、SurfaceView、layer、buffer,这些本质上没啥区别,可以广泛意义上理解为用于显示内容的那块内存,只不过各个阶段的操作接口不同。

oDwyane03的博客 1353

P11:JSX代码注释、HTML添加class、JSX中解析html、JSX中label激活文本框

React16 基础阐述JSX代码注释JSX中的class陷阱JSX中的html解析问题JSX中 `` 标签的坑 阐述 通过之前的教程作完“大宝剑”菜单后,如果你跟着我做出来了,说明你的React已经入门了。 也是一个好的开始,接下来的路虽然还很长,但会平坦的多。本文就讲一下JSX语法中需要注意的几个小坑。 JSX代码注释 JSX中的代码注释是非常有讲究的,这个书上介绍的也非常少,所以在这里讲一下,因为我在初学React在这里踩过坑。 我第一次写JSX注释,是直接这样写的,当然这样写是完全不对的。 <

wgchen 2193

JavaScript注释

为了提高代码的可读性,JS与CSS一样,也提供了注释功能。JS中的注释主要有两种,分别是单行注释多行注释。为了方便信息的输入输出,JS中提供了一些输入输出语句本文章讲述了js的单,多行注释使用,JavaScript的常用输出语句。https。...

一名在校学习前端的小白 9788

javascript有几种注释方法?

1.3 JavaScript 注释 1. 单行注释 符号:// 作用://右边这一行的代码会被忽略 快捷键:ctrl + / 2. 块注释 符号:/* */ 作用:在/* */ 之间的所有内容都会被忽略 快捷键:shift + alt + A

Webkaifadongge的博客 3586

如何在JSX代码里编写注释(React)

格式 { /*注释内容*/ } 案例

weixin_43694465的博客 943

JavaScript基础语法2

/</// 我通过var关键字声明了一个变量age,同时为age赋值为20/*第一行第二行第三行*/var20;log;</</<//* */是英文状态下进行编辑的,///* */注释的内容可以是文字也可以是代码温馨提示:快捷键是Ctrl+/,按一下是快速注释,再按一下也可以是快速解除注释。</</</<//* */温馨提示:快捷键Ctrl+/,按一下是快速注释,再按一下也可以是快速解除注释。</</</</</

2401_84424522的博客 767

eclipse 中的注释 快捷键 多行注释快捷键 单行注释快捷键

Eclipse 中的两种注释方法: (1)多行注释 (2)单行注释 一、 多行注释快捷键 1:添加注释 Ctrl+Shift+/ :    添加/* */注释  示例: 选中代码块后按下快捷键即可 /* float size = 0.0f;    float pct = 0.0f;    try { size = Float.parseFloat(resInf

a0701302的专栏 17万+

html——注释单行注释 多行注释

HTML注释: &lt;!--这是单行注释--&gt; &lt;!--     这是多行注释     这是多行注释     这是多行注释 --&gt; JS/jQuery注释: //这是单行注释 /*     这是多行注释     这是多行注释     这是多行注释 */ css注释: /*这是单行注释*/ /*     这是多行注释     这是多行注释     这是多行注释 ...

杰儿__er 的博客 17万+

JS注释多行注释+单行注释

本篇文章由泉州SEOwww.234yp.com 整理发布,js教程www.234yp.com/Article/188272.html谢谢合作!js教程注释就是不被解析的一串字符。JavaScript 注释有以下两种方法: 单行注释://单行注释信息。 多行注释:/*多行注释信息*/。 示例1 把位于//字符后一行内的所有字符视为单行注释信息。下面几条注释语句可以位于代码段的不同位置,分别描述不同区域代码的功能。 //程序描述 function toStr(a){ //块描述 //代码...

dxxxxx178的博客 2477

正则表达式匹配单行多行注释思路详解

我的需求是用new Function去执行一段javascript代码,怕代码一多,注释会影响效率,因此我需要寻找字符串的所有类型的注释,将其全部替换为空字符串。

qq_55188913的博客 5975

JavaScriptJavaScript 简介 ③ ( JavaScript 单行/多行注释 | 输入输出语句 | prompt 函数 | alert 函数 | console.log 函数 )

一、JavaScript 注释 1、单行注释 2、多行注释 3、设置多行注释快捷键 二、JavaScript 输入输出语句 1、浏览器输入框 - prompt() 2、浏览器警告框 - alert() 3、浏览器控制台输出 - console.log()

让 学习 成为一种 习惯 ( 韩曙亮 の 技术博客 ) 3615

Eclipse中多行单行、文档)注释快捷键

代码块注释: 方法一:以“ // ”进行注释 添加注释:在java代码中,选中要注释的代码块或者一行代码,然后按键盘“ Ctrl + shift + C ”或者“ Ctrl + / ”进行注释,该快捷键既可以注释单行也可以注释多行 多行注释单行注释: 取消注释:直接按相同的快捷键“ Ctrl + shift + C ”或者“ Ctrl + / ” 添加注释:在XML代码中,...

IT界幼稚生的博客 2万+

JS | 如何规范 JavaScript注释

规范JavaScript注释方法包括使用单行注释多行注释、使用JSDoc风格的注释以及采用一致的注释习惯。其中,使用JSDoc风格的注释是为了提高代码的可读性维护性,通过在函数变量声明之前添加规范化的注释,为代码的每一部分提供清晰的文档说明。这种做法不仅有助于团队成员之间的沟通,也便于未来的代码维护更新。

青春木鱼的博客 2149

注释规范:单行多行注释

注释是编程中的一门艺术,平衡解释与简洁至关重要。单行注释适合简短说明,而多行注释用于详细描述。通过遵循规范、使用工具如Mermaid图表文档生成器,你可以提升代码质量。记住,好的注释不是重复代码,而是阐明意图原因。在团队中,制定并遵守注释规范,定期审查,以确保代码库的长期健康。如果你对注释规范有更多疑问,可以探索W3Schools 的注释指南获取语言特定示例。🚀 记住,清晰的注释是给未来自己同事的礼物。

always_TT的博客 612

JavaScript注释多行注释+单行注释

JavaScript注释多行注释+单行注释注释就是不被解析的一串字符。JavaScript 注释有以下两种方法: 单行注释://单行注释信息。 多行注释:/*多行注释信息*/。 示例1 把位于//字符后一行内的所有字符视为单行注释信息。下面几条注释语句可以位于代码段的不同位置,分别描述不同区域代码的功能。 //程序描述 function toStr(a){ //块描述 //代码段描述 return a.toString(); //语句描述 } 使用单行注释时,在//后

我的博客 5898

jsp 单行注释多行注释_eclipse 中的注释 快捷键 多行注释快捷键 单行注释快捷键...

本文链接:https://blog.csdn.net/a0701302/article/details/76177244Eclipse 中的两种注释方法: (1)多行注释 (2)单行注释一、 多行注释快捷键 1:添加注释 Ctrl+Shift+/ : 添加/* */注释 示例: 选中代码块后按下快捷键即可/*float size = 0.0f;float pct = 0.0f;try {s...

weixin_42099302的博客 2801

HTML中的单行注释标签是,html如何单行多行注释呢 ?

html如何单行多行注释 ?html文档中单行多行注释是“”。 但小编一直觉得,忘却就是一种原谅,即便不是最高尚的那一种。在html文档中,body标签内的内容可以用“”进行单行多行注释: 那个三月好不平静,悲欢离合,痛彻心扉!多么想听到一句:愚人节快乐,三月是一场梦。在html文档中,script标签内的内容可以用“//”进行单行多行注释: 爱你的温度就像微波炉”,你就是小编的一盘菜...

weixin_30305029的博客 2360
上一篇: 这个网站真的太香了!居然可以免费领AI工具会员和“智能AI聊天助手”项目源码!!!
下一篇: JavaScript精粹:26个关键字深度解析,编写高质量代码的秘诀!
云端源想
博客等级 码龄4年 1019粉丝 109原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值