JavaScript注释规范

你好，我是云桃桃。

一个希望帮助更多朋友快速入门 WEB 前端的程序媛。

云桃桃 ，大专生，一枚程序媛，感谢关注。回复 “前端基础题”，可免费获得前端基础 100 题汇总，回复 “前端基础路线”，可获取完整web基础路线导图。

308篇原创内容-更多前端系列内容可以go公众.h：云桃桃

后台回复“前端基础路线”可获取前端基础学习路线

后台回复“前端基础题”可得到前端基础100题汇总，持续更新中

后台回复“前端电子书”可获取20+本精选电子书

前言

在 JavaScript 中，注释就像是代码中的笔记，它可以帮助我们解释代码的功能、记录重要信息或者暂时禁用一段代码。

好，那我们一起来看看吧。

2 种注释的写法

以下是 JavaScript 中常见的注释方式：

1. 单行注释：使用//开头，注释内容从//开始到本行结束。

2. 多行注释：使用/*开头，*/结尾，注释内容可以跨越多行。

代码如下：

// 这是一个单行注释
let myVariable = 5

/* 
 这是一个多行注释，用于解释下面的代码逻辑
  let myFunction = function() {
    console.log("Hello, World!");
  }
*/

要注意的是，多行注释不能嵌套多行注释，以下是一个错误的注释嵌套示例。

  /*
    这是一个/*注释
    这是一个嵌套的*/注释
  */

在代码里也会有报错的提示，如图。

注释的常见作用有以下 4 点：

1. 解释代码：通过添加注释，可以让其他人更容易理解你的代码逻辑和意图。

// 这是一个计算圆的面积的函数
function calculateCircleArea(radius) {
  return Math.PI * radius * radius
}

1. 记录重要信息：可以在注释中记录代码的版本、作者、日期等重要信息。

// 作者：桃
// 创建日期：2024-05-06
function myFunction() {
  // 这里实现了具体的功能
}

1. 暂时禁用代码：在调试或测试代码时，可以使用注释暂时禁用一段代码，以便观察代码的执行效果。

// 注释掉这段代码，暂时禁用它
// console.log(name)
console.log(name + '测试测试666666')

1. 提高代码的可读性：合理的注释可以使代码更加清晰，易于阅读和维护。

function myComplexFunction() {
  // 初始化变量
  let x = 0
  let y = 0

  // 执行复杂的计算逻辑

  // 返回计算结果
  return x + y
}

注释的 4 个注意点

1. 注释应该与代码保持一致，当代码发生变化时，注释也应该相应地更新。

2. 避免在注释中写下与代码无关的内容，以免干扰其他人对代码的理解。

3. 对于复杂的代码块或函数，可以在注释中提供更多的解释和说明，帮助其他人更好地理解代码的结构和逻辑。

4. 不要过度注释，应该只在必要的地方添加注释，以免影响代码的可读性。

OK，本文完。