JavaScript注释

精华

小牛编辑

209浏览

2023-03-14

注释是给开发人员看的，程序在执行时会自动忽略注释的内容，所以我们通常使用注释来为代码添加一些解释说明或描述，以提高代码的可读性。 JavaScript 中的注释与 C/ C++、 Java、 PHP 等语言中注释的定义方式相同，支持单行注释和多行注释两种风格。

1. 单行注释

单行注释以双斜杠 //开头， //之后的所有内容都会看作是注释的内容，对 //之前的内容则不会产生影响，示例代码如下：

<!DOCTYPE html>
<html>
<head>
    <title>JavaScript</title>
</head>
<body>
    <div id="demo"></div>
    <script>
        // 在 id 属性为 demo 的标签中添加指定内容
        document.getElementById("demo").innerHTML = "https://www.xnip.cn/javascript/";
    </script>
</body>
</html>

注意：单行注释 // 只对所在行有效。

另外，单行注释除了可以独占一行外，也可以在代码的末尾使用，如下例所示：

var x = 5;      // 声明变量 x，并把 5 赋值给它
var y = x + 2;  // 声明变量 y，并把 x+2 赋值给它

2. 多行注释

多行注释以 /* 开头，并以 */ 结尾，出现在 /* 和 */ 之间的所有内容都会看作是注释的内容，示例代码如下：

<!DOCTYPE html>
<html>
<head>
    <title>JavaScript</title>
</head>
<body>
    <div id="demo"></div>
    <script>
        /*
        在 id 属性为 demo 的标签中
        添加指定内容
        */
        document.getElementById("demo").innerHTML = "https://www.xnip.cn/javascript/";
    </script>
</body>
</html>

3. 使用注释来阻止程序执行

使用注释除了可以为代码添加解释说明或描述外，在调试代码的时候，我们也可以将不需要运行的代码注释起来，这样在运行程序时浏览器就会忽略注释中的代码。如下例所示：

<!DOCTYPE html>
<html>
<head>
    <title>JavaScript</title>
</head>
<body>
    <div id="demo"></div>
    <script>
        document.getElementById("demo").innerHTML = "JavaScript教程";
        // document.getElementById("demo").innerHTML = "JavaScript";
        /*
            document.getElementById("demo").innerHTML = "注释";
            document.getElementById("demo").innerHTML = "JavaScript注释";
         */
    </script>
</body>
</html>

4. HTML 注释

JavaScript 还能够识别 HTML 注释的开始符  JavaScript 则不能识别，因此若要使用 HTML 注释来注释 JavaScript 代码，应该使用 JavaScript 的单行注释将 HTML 注释的结束符 --> 注释掉，例如 //-->。示例代码如下：

<!--document.getElementById("demo").innerHTML = "小牛知识库";
// -->
// document.getElementById("demo").innerHTML = "小牛知识库";

上面代码中，两种注释的效果是一样的。