Javascript注释

一起看海

随着时间推移，程序变得越来越复杂。为代码添加 注释 来描述它做了什么和为什么要这样做，变得非常有必要了。

你可以在脚本的任何地方添加注释，它们并不会影响代码的执行，因为引擎会直接忽略它们。

单行注释以两个正斜杠字符 // 开始。

这一行的剩余部分是注释。它可能独占一行或者跟随在一条语句的后面。

就像这样：

// 这行注释独占一行
alert('Hello');

alert('World'); // 这行注释跟随在语句后面
多行注释以一个正斜杠和星号开始 “/*” 并以一个星号和正斜杠结束 “*/”。

就像这样:

/* 两个消息的例子。
这是一个多行注释。
*/
alert('Hello');
alert('World');
注释的内容被忽略了，所以如果我们在 /* … */ 中放入代码，并不会执行。

有时候，可以很方便地临时禁用代码：

/* 注释代码
alert('Hello');
*/
alert('World');
使用快捷键！
在大多数的编辑器中，一行代码可以使用 Ctrl+/ 快捷键进行单行注释，诸如 Ctrl+Shift+/ 的快捷键可以进行多行注释（选择代码，然后按下快捷键）。对于 Mac 电脑，应使用 Cmd 而不是 Ctrl，使用 Option 而不是 Shift。

不支持注释嵌套！
不要在 /*...*/ 内嵌套另一个 /*...*/。

下面这段代码报错而无法执行：

/*
  /* 嵌套注释 ?!? */
*/
alert( 'World' );
对你的代码进行注释，这还有什么可犹豫的！

注释会增加代码总量，但这一点也不是什么问题。有很多工具可以帮你在把代码部署到服务器之前缩减代码。这些工具会移除注释，这样注释就不会出现在发布的脚本中。所以，注释对我们的生产没有任何负面影响。

在后面的教程中，会有一章 代码质量 的内容解释如何更好地写注释。