JavaScript 注释：提升代码可读性和维护性
在编程中，注释是一个重要的组成部分，它帮助开发者理解代码逻辑、临时禁用代码段或提供额外的信息。JavaScript 提供了两种主要的注释方式：单行注释和多行注释。
单行注释
单行注释是最常见的注释形式，以两个斜杠 // 开头。在 // 之后直到行尾的所有内容都会被 JavaScript 解释器忽略。
单行注释的使用场景：
- 解释代码：对复杂的代码行或特殊逻辑提供解释。
- 临时禁用代码：在调试过程中，通过添加
//来临时移除某行代码的效果。
单行注释的代码示例
// 设置页面标题
document.getElementById("myH1").innerHTML = "欢迎来到我的主页";
// 向段落元素添加文本内容
document.getElementById("myP").innerHTML = "这是我的第一个段落。";
多行注释
多行注释用于需要跨越多行的注释情况，以斜杠加星号 /* 开始，星号加斜杠 */ 结束。在这个区间内的所有内容都会被忽略。
多行注释的使用场景：
- 大段的解释：当需要对多行代码或整个功能模块提供解释时。
- 临时移除代码块：在调试时，可以一次性注释掉整个代码块。
多行注释的代码示例
/*
这是一个多行注释示例，
用于解释下面的代码块。
*/
function greet() {
// 这里调用了问候函数
console.log("Hello, World!");
}
注意事项
- 避免过度使用注释。清晰的代码结构和命名通常比大量的注释更有用。
- 确保注释是准确的，过时或误导性的注释可能会引起混淆。
- 定期审查和更新注释，特别是在代码重构或更新后。
代码示例
以下是一个包含单行和多行注释的完整示例：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>注释示例</title>
</head>
<body>
<h1 id="myH1">标题待更新</h1>
<p id="myP">段落待更新。</p>
<script>
// 设置页面标题
document.getElementById("myH1").innerHTML = "欢迎来到我的主页";
// 向段落元素添加文本内容
document.getElementById("myP").innerHTML = "这是我的第一个段落。";
/*
下面的函数用于输出问候语，
但在本例中我们选择不执行它。
*/
// function greet() {
// console.log("Hello, World!");
// }
</script>
</body>
</html>
