注释可以通过单行（//）或多行（/ /）文本在代码中添加说明。最佳实践包括保持注释的目的性、清晰简洁、与代码同步并采用标准格式。
如何注释 JS 代码
注释是代码中的说明性文本，可帮助开发人员和读者理解代码的目的、功能和用法。注释对于增强代码可读性、维护性和可调试性至关重要。
类型
JS 代码有两种类型的注释：
- 单行注释：以双斜杠（//）开头，到行尾结束。
- 多行注释：以 / 开头，以 / 结尾。
最佳实践
注释应遵循以下最佳实践：
- 有目的：仅在必要时使用注释。不要添加不提供有价值信息的注释。
- 清晰简洁：注释应明确简洁，易于理解。避免使用冗长的或模糊的语言。
- 及时更新：当代码发生变化时，请更新注释以反映新功能。过时的注释可能会造成混淆和问题。
- 使用标准格式：为注释采用一致的格式。这将提高代码的可读性和维护性。
如何注释
单行注释：
// 使用单行注释来描述单行的目的或功能
多行注释：
/* 使用多行注释来描述代码块， 提供有关其功能、用法和其他详细信息的信息。 */
代码示例
以下代码示例显示了如何在 JS 代码中使用注释：
// 定义一个函数来计算圆的面积
function calculateArea(radius) {
// 检查是否提供了半径
if (radius === undefined) {
throw new Error("半径不能为空。");
}
// 计算并返回面积
return Math.PI * radius ** 2;
}通过添加注释，该代码变得更加易于理解和维护。
