JavaScript 注释用于解释代码的用途。注释 不作为程序的一部分执行,它们仅用于人类开发人员更好地理解代码。
您可以将注释用于各种目的,例如 -
- 解释特定代码段的用途。
- 将文档添加到代码中,供你自己和可能阅读它的其他人使用。
- 暂时禁用或“注释掉”用于测试或调试的代码块,而不删除它。
一个好的开发人员总是写一条注释来解释代码。
在 JavaScript 中编写注释有两种常见的方法 -
- 单行注释
- 多行注释
JavaScript 中的单行注释
我们可以用双正斜杠 (//) 开始单行注释。我们可以在 // 和行尾之间写上注释。
语法
单行注释的语法如下 -
<script>
// 这里是注释
</script>
例
在下面的示例中,我们使用单行注释解释了 JavaScript 代码的每个步骤。在输出中,代码打印串联的字符串。
<html>
<head>
<title> Single line comments </title>
</head>
<body>
<script>
// 定义字符串1
var string1 = "JavaScript";
// 定义字符串2
var string2 = "TypeScript";
// 打印字符串
document.write(string1, " ", string2);
</script>
</body>
</html>
例
在下面的示例中,我们注释了 'bool1 = false;' 行以避免执行该代码。在输出中,我们可以看到 bool1 变量的值为 true,因为我们注释掉了代码,这会更新 bool1 变量的值。
此外,我们可以在编写代码后添加单行代码,就像我们在 document.write() 方法之后添加的那样。
<html>
<head>
<title> Single line comments </title>
</head>
<body>
<script>
var bool1 = true;
// bool1 = false;
document.write("bool1的值为: ", bool1); // 打印变量值
</script>
</body>
</html>
JavaScript 中的多行注释
当我们需要注释多行代码或解释较大的代码时,多行注释非常有用。我们可以在 /* 和 */ 之间编写多行注释。
语法
多行注释的语法如下 -
<script>
/* 注释的第一行
注释的第二行 */
</script>
例
在下面的示例中,我们定义了 'a' 和 'b' 变量。之后,我们编写了代码,将 'a' 和 'b' 的值交换为 3 行,并使用多行注释注释掉。
输出会打印 'a' 和 'b' 的实际值,因为浏览器会忽略注释的代码。
<html>
<head>
<title> Multi line comments </title>
</head>
<body>
<script>
var a = 100;
var b = 200;
/* a = a + b;
b = a - b;
a = a - b; */
document.write("a = " + a + "<br>" + "b = " + b);
</script>
</body>
</html>
始终在您的代码中编写注释,因为它可以帮助其他协作者理解您的代码。