JavaScript 注释

JavaScript 注释

JavaScript 注释用于向代码添加解释性说明，使其更容易被您自己和他人理解。

注释会被 JavaScript 引擎忽略，不会影响程序的执行。它们也可以用于临时禁用代码行，以便进行测试。

单行注释

单行注释以 // 开头。

从 // 到当前行末尾的任何文本都被视为注释，会被 JavaScript 忽略。

示例：使用单行注释解释代码：

// 获取标题元素并更改其文本内容
const myHeading = document.getElementById("myH");
myHeading.textContent = "My Updated Page Title";

// 获取段落元素并更新其内容
const myParagraph = document.getElementById("myP");
myParagraph.textContent = "This is my updated first paragraph.";

示例：在行末使用单行注释：

let x = 5;      // 声明变量 x 并赋值 5
let y = x + 2;  // 声明变量 y 并赋值 x + 2 (即 7)

多行注释

多行注释以 /* 开头，以 */ 结尾。

位于 /* 和 */ 之间的任何文本都会被 JavaScript 忽略，无论它跨越多行。

示例：使用多行注释（注释块）解释代码段：

/*
以下代码块执行两个操作：
1. 获取 ID 为 'myH' 的 HTML 元素并更新其内容。
2. 获取 ID 为 'myP' 的 HTML 元素并更新其内容。
这对于更详细的解释非常有用。
*/
document.getElementById("myH").innerHTML = "My First Page Revisted";
document.getElementById("myP").innerHTML = "My first paragraph, updated again.";

	虽然这两种注释类型都有用，但单行注释（//）通常更适用于简短、简洁的解释，而多行注释（/* ... */）则适合较长的描述或临时禁用大段代码。JSDoc 注释使用 /** ... */ 语法，是用于生成文档的特殊形式的多行注释。

使用注释阻止代码执行（调试）

注释掉代码是开发和调试过程中常用的一种技术，用于临时阻止某些代码行或代码块运行，而无需删除它们。

示例：使用 // 阻止一行代码执行：

// document.getElementById("myH").innerHTML = "This line is commented out."; // 这一行被注释掉了
document.getElementById("myP").innerHTML = "This paragraph will be updated.";

示例：使用多行注释阻止多行代码执行：

/*
console.log("This will not be logged."); // 这行不会被输出
const importantValue = 42;
if (importantValue > 10) {
    console.log("This block is also commented out."); // 这整个块也被注释掉了
}
*/
console.log("This line will execute.");

这使您能够隔离部分代码，以便查找错误或测试不同的方法。