JS添加注释
点击打开在线编译器，边学边练
注释在代码中的作用非常重要。它们为开发人员提供了关于代码功能和逻辑的解释说明，帮助他们更好地理解和维护代码。
JavaScript注释
注释内容JS不会执行。
我们开发人员可以添加注释来增加代码的可读性。在 JavaScript 中，我们有两种常见的注释风格。
这里使用单行注释来举例
// 输出标题：
document.getElementById("myHead").innerHTML="欢迎来到Js编程的世界";
// 输出段落：
document.getElementById("myP").innerHTML="这是第一个段落。";JavaScript 单行注释
单行注释使用双斜杠（//）开始，从双斜杠后面到该行结束的所有内容都会被视为注释。
例如：
// 这是一个单行注释，用于解释下面一行代码的功能 var x = 5; // 定义变量 x 并赋值为 5
实例：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>www.dotcpp.com</title>
</head>
<body>
<h1 id="myHead"></h1>
<p id="myP"></p>
<script>
// 输出标题：
document.getElementById("myHead").innerHTML="欢迎来到Js编程的世界";
// 输出段落：
document.getElementById("myP").innerHTML="这是第一个段落。";
</script>
<p><b>注释：</b>注释不会被执行。</p>
</body>
</html>
（运行结果）
JavaScript 多行注释
多行注释使用斜杠星号（/*）开始，星号斜杠（*/）结束，之间的所有内容都会被视为注释。
例如：
/* 这是一个多行注释， 可以跨越多行， 用于对一段代码进行详细的解释说明。 */ var y = 10; // 定义变量 y 并赋值为 10
实例：
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>www.dotcpp.com</title>
</head>
<body>
<h1 id="myHead"></h1>
<p id="myP"></p>
<script>
/*
document.getElementById("myHead").innerHTML="欢迎来到我的主页";
document.getElementById("myP").innerHTML="这是我的第一个段落。";
*/
</script>
<p><strong>注意:</strong>注释块不会被执行。</p>
</body>
</html>
（运行结果）
通过使用这些注释风格，我们可以提高代码的可读性和可维护性，使其他人更轻松地理解我们的代码意图和功能。
使用注释来阻止执行
注释用于阻止其中一条代码行的执行（可用于调试）：
// document.getElementById("myH1").innerHTML="欢迎来到我的主页";
document.getElementById("myP").innerHTML="这是我的第一个段落。";这一节我们学习了有关代码注释方面的知识，我们要养成一个好的习惯就是写注释，方便你二次阅读，维护你的代码。
如果后面项目转手，也方便别人来理解你的代码和维护你的代码。
当你编写注释时，应该注意以下几点：
- 注释应该是清晰、简洁、准确的。不要使用过于复杂或含糊不清的语言。
- 注释应该描述代码的意图和功能，而不是简单地重复代码本身。
- 如果可能的话，注释应该包括一些示例或演示，以帮助其他人更好地理解代码。
- 注释应该针对你的目标受众编写。如果你的代码是面向其他开发人员的，那么你的注释可能需要更加详尽和技术性。如果你的代码是面向非技术人员的，那么你的注释可能需要更加易懂和用户友好。
通过养成良好的注释习惯，我们可以使我们的代码更加易读、易维护，并且更加值得信赖。
下一节我们将正式学习有关编码方面的基础知识。
本文固定URL：https://www.dotcpp.com/course/1256