JavaScript 注释是代码中的注解,会被编译器完全忽略。例如,
// display "Programiz" to the screen
console.log("Programiz");
输出
Programiz
在这里,// display "Programiz" to the screen
是一个注释。因此,JavaScript 引擎会忽略它。
JavaScript 注释的类型
在 JavaScript 中,有两种添加代码注释的方法
//
- 单行注释/* */
- 多行注释
单行注释
在 JavaScript 中,任何以 //
开头的行都是单行注释。例如,
name = "Jack";
// display name on the console
console.log("Hello " + name);
在这里,// display name on the console
是一个单行注释。
注意:你也可以这样使用单行注释
name = "Jack";
console.log("Hello " + name); // display name on the console
但是,如果注释很长且描述性强,请避免这样使用注释。
多行注释
在 JavaScript 中,多行注释允许你添加可以跨越多行的注释。它们以 /*
开始,以 */
结束。例如,
/* This is a multiline comment.
It can span several lines.
*/
let numberOfStudents = 50;
console.log(numberOfStudents);
在这里,我们使用了一个可以跨越多行的多行注释。
如果你想移除当前不需要但将来可能仍有用的代码行,注释会很有帮助。考虑下面的程序
console.log("Welcome to JavaScript programming.");
console.log("JavaScript is fun!");
假设 console.log("JavaScript is fun!");
这一行目前不需要。但你知道你将来可能会改变主意。
在这种情况下,你可以简单地将不需要的行转换为注释,而不是从程序中删除它。
这样,当你需要使用这段代码时,就可以取消注释。
console.log("Welcome to JavaScript programming.");
// console.log("JavaScript is fun!");
让代码更易于理解
作为一名 JavaScript 开发者,你会编写代码,并且还需要更新别人编写的代码。
如果你在代码中添加注释,将来你更容易理解代码。你的同事开发者也将更容易理解代码。
作为一条经验法则,使用注释来解释你做某事的原因,而不是如何做。
注意事项
- 不应该使用注释来解释写得不好的代码。你的代码应该始终结构良好且自成一体。
- 记住使用注释的快捷键;这会非常有用。对于大多数代码编辑器,Windows 上是
Ctrl + /
,Mac 上是Cmd + /
。