JavaScript 注释

在 JavaScript 中,为一些关键代码注释是非常有必要的。注释的好处很多,比如方便理解、方便查找或方便项目组里的其他开发人员了解你的代码,而且也方便以后你对自己的代码进行修改。

对于 JavaScript 注释,可以分为以下 2 种。

  • 单行注释。
  • 多行注释。

JavaScript 单行注释

在 JavaScript 中,当注释的内容比较少(比如只有一行)时,我们可以使用单行注释的方式。

语法:

// 单行注释

说明:

特别注意,HTML、CSS 和 JavaScript 这 3 个注释是不一样的。此外,并不是什么地方我们都要注释,一般情况只会对一些关键功能的代码进行注释。

对于 HTML 和 CSS 的注释,另请参阅:

示例 1:使用单行注释

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title></title>
    <style>
        /* 这是CSS注释 */
        body { color: red; }
    </style>
</head>
<body>
    <script>
        // 这是JavaScript注释
        console.log("不要把无知当个性");
    </script>
    <!--这是HTML注释-->
    <div>绿叶网</div>
</body>
</html>

页面效果如下图所示。

JavaScript 单行注释

分析:

从结果可以看出,被注释的内容是不会在浏览器中显示出来的。

JavaScript 多行注释

当注释的内容比较多,用一行表达不出来时,我们可以使用多行注释的方式。

语法:

/* 
  注释内容
  注释内容
  注释内容
*/

说明:

有小伙伴可能会说,HTML、CSS、JavaScript 注释都不一样,而 JavaScript 还分单行注释和多行注释,我都记不住啊!其实小伙伴们不需要去死记,稍微留个印象就可以了,因为开发工具都会有代码高亮的提示功能。平常要是忘了的话,在编辑器中测试一下就知道了。

实际上,在大多数编辑器(如 VS Code)中,我们可以使用快捷键 “Ctrl + /” 来快速切换注释。这是开发中最高频的操作之一。

示例 2:使用多行注释

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title></title>
    <style>
        /* 这是CSS注释 */
        body { color: red; }
    </style>
</head>
<body>
    <script>
        /*
          这是JavaScript注释(多行)
          这是JavaScript注释(多行)
          这是JavaScript注释(多行)
         */
        console.log("不要把无知当个性");
    </script>
    <div>绿叶网</div>
</body>
</html>

页面效果如下图所示。

JavaScript 多行注释

分析:

当然,如果注释的内容只有一行,我们也可以采用多行注释方式。

提示: 在实际开发中,我们可能会见到一种以 “/**” 开头的多行注释(多了一个星号)。这种注释方式被称为 “文档注释(JSDoc)”,它主要用于自动生成代码文档,或让编辑器提供更智能的代码提示。

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号