这里是云端源想IT，帮你轻松学IT”

嗨~ 今天的你过得还好吗？

天空一无所求

任树木自由生长

- 2024.04.22 -

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

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

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

一、什么是JavaScript注释

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

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

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

二、JavaScript注释的种类

1、单行注释

单行注释：使用两个斜杠（//）开头，后面的内容直到该行结束都被视为注释。例如：

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

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

2、多行注释

多行注释：使用斜杠星号（/）开头，星号斜杠（/）结尾，中间的内容都被视为注释。

例如：

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

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

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

注意：在HTML文件中，如果需要将JavaScript代码嵌入到<script>标签中，可以使用以下方法来添加多行注释：

<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注释是我们编程过程中的得力助手，它们不仅能够帮助我们更好地理解代码，还能提高代码的可读性和可维护性。让我们一起学会使用注释，让我们的代码更加精彩！

如果觉得本文对你有所帮助，别忘了点赞和分享哦！

我们下期再见！

END

文案编辑|云端学长

文案配图|云端学长

内容由：云端源想分享

释（Comments）用来向用户提示或解释某些代码的作用和功能，它可以出现在代码中的任何位置。Python解释器在执行代码时会忽略注释，不做任何处理，就好像它不存在一样。

在调试（Debug）程序的过程中，注释还可以用来临时移除无用的代码。

注释的最大作用是提高程序的可读性，没有注释的程序简直就是天书，让人吐血！

千万不要认为你自己写的代码规范就可以不加注释，甩给别人一段没有注释的代码是对别人的不尊重，是非常自私的行为；你可以喜欢自虐，但请不要虐待别人。

很多程序员宁愿自己去开发一个应用，也不愿意去修改别人的代码，没有合理的注释是一个重要的原因。虽然良好的代码可以自成文挡，但我们永远不清楚今后阅读这段代码的人是谁，他是否和你有相同的思路；或者一段时间以后，你自己也不清楚当时写这段代码的目的了。

一般情况下，合理的代码注释应该占源代码的1/3左右。

Python支持两种类型的注释，分别是单行注释和多行注释。

Python单行注释

Python使用井号#作为单行注释的符号，语法格式为：

#注释内容

从井号#开始，直到这行结束为止的所有内容都是注释。Python解释器遇到#时，会忽略它后面的整行内容。

说明多行代码的功能时一般将注释放在代码的上一行，例如：

#使用print输出字符串
print("Hello World!")
print("开课吧广场")
print("https://topic.kaikeba.com/biancheng/python")
#使用 print输出数字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )12345678复制代码类型：[python]

说明单行代码的功能时一般将注释放在代码的右侧，例如：

print("https://topic.kaikeba.com/biancheng/python")  #输出Python教程的地址
print( 36.7 * 14.5 )  #输出乘积
print( 100 % 7 )  #输出余数123复制代码类型：[html]

Python多行注释

多行注释指的是一次性注释程序中多行的内容（包含一行）。

Python使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容，具体格式如下：

'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''12345复制代码类型：[python]

或者

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""12345复制代码类型：[python]

多行注释通常用来为Python文件、模块、类或者函数等添加版权或者功能描述信息。

注意事项

1)Python多行注释不支持嵌套，所以下面的写法是错误的：

'''
外层注释
    '''
    内层注释
    '''
'''123456复制代码类型：[python]

2)不管是多行注释还是单行注释，当注释符作为字符串的一部分出现时，就不能再将它们视为注释标记，而应该看做正常代码的一部分，例如：

print('''Hello,World!''')
print("""https://topic.kaikeba.com/biancheng/python""")
print("#是单行注释的开始")123复制代码类型：[html]

运行结果：

Hello,World!
https://topic.kaikeba.com/biancheng/python
#是单行注释的开始123复制代码类型：[html]

对于前两行代码，Python没有将这里的三个引号看作是多行注释，而是将它们看作字符串的开始和结束标志。

对于第3行代码，Python也没有将井号看作单行注释，而是将它看作字符串的一部分。

注释可以帮助调试程序

给代码添加说明是注释的基本作用，除此以外它还有另外一个实用的功能，就是用来调试程序。

举个例子，如果你觉得某段代码可能有问题，可以先把这段代码注释起来，让Python解释器忽略这段代码，然后再运行。如果程序可以正常执行，则可以说明错误就是由这段代码引起的；反之，如果依然出现相同的错误，则可以说明错误不是由这段代码引起的。

在调试程序的过程中使用注释可以缩小错误所在的范围，提高调试程序的效率。

开课吧广场-人才学习交流平台

释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。

Java 支持以下三种注释方式：

1）单行注释

以双斜杠“//”标识，只能注释一行内容，用在注释信息内容少的地方。打开 Eclipse，在 Java 代码中使用单行注释，如图 1 所示。

图 1 单行注释

2）多行注释

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看），如图 2 所示。

注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。

图 2 多行注释

3）文档注释

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容，如图 3 所示。

注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。

图 3 文档注释

文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档，并输出到 HTML 文件中，方便记录程序信息。还可以包含一个或多个 @ 标签，每个 @ 标签都在新的一行开始。关于 Javadoc 的具体标签和使用可阅读学习《Javadoc入门教程》一节。

在 Java 中，一行注释以双斜杠“//”标识；多行注释包含在“/*”和“*/”之间；文档注释包含在“/**”和“*/”之间。当编译器执行到“//”时，就会忽略该行“//”之后的所有文本；当执行到“/*”时，会扫描下一个“*/”并忽略“/*”和“*/”之间的任何文本；当执行到“/**”时，也会扫描下一个“*/”并忽略“/**”和“*/”之间的任何文本内容。

还有更多java学习知识可以看下方视频，学习更全面，需要源码资源库的可以评论区扣'999’免费领取。

「链接」