JavaScript 注释

Question

在本教程中，您将了解 JavaScript 注释，为什么使用它们以及如何在示例的帮助下使用它们。JavaScript 注释是程序员可以添加的提示，以使他们的代码更易于阅读和理解。它们被 JavaScript 引擎完全忽略。

---

有两种方法可以向代码添加注释：

• // -单行注释
• /* */ -多行注释

---

单行注释

在 JavaScript 中，任何以 // 开头的行都是注释。例如，

name = "Jack";

// printing name on the console
console.log("Hello " + name);

在这里， // printing name on the console 是注释。

您还可以使用像这样的单条注释：

name = "Jack";

console.log("Hello " + name);  // printing name on the console

---

多行注释

在 Javascript 中， /* 和 */ 之间的任何文本也是注释。例如，

/* The following program contains the source code for a game called Baghchal. 

Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid.

For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board.

For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal.
*/

由于其余的源代码将用于实现游戏规则，因此上面的注释是一个很好的示例，您可以在其中使用多行注释。

---

使用注释进行调试

注释也可以用于禁用代码以阻止其执行。例如，

console.log("some code");
console.log("Error code);
console.log("other code");

如果在运行程序时遇到错误，则可以删除注释，而不是删除容易出错的代码，而可以通过注释禁止它执行。这可能是有价值的调试工具。

console.log("some code");
// console.log("Error code);
console.log("other code");

专家提示： 请记住使用注释的快捷方式；这真的很有帮助。对于大多数代码编辑器，对于 Windows 是 Ctrl + / ，对于 Mac 是 Cmd + / 。

---

使代码更容易理解

作为 JavaScript 开发人员，您不仅会编写代码，而且可能还必须修改其他开发人员编写的代码。如果您在代码上写注释，将来您将更容易理解代码。而且，您的其他开发人员将更容易理解代码。

作为一般的经验法则，请使用注释来解释您 为什么 做某事，而不是 如何 做某事，并且您是好人。注意： 注释不能替代用英语解释写得不好的代码的方法。您应该始终编写结构合理且易于解释的代码。然后，使用注释。