JavaScript 注释

注释是写给"人"看的说明文字,浏览器在执行时会完全忽略它。给代码加注释,能让你自己或同伴更快看懂逻辑,是每个程序员的基本功。

为什么写注释

  • 解释"这段代码在干什么、为什么要这么写"。
  • 关键算法、复杂逻辑如果没有注释,几乎没人能快速读懂。
  • 团队协作时,注释是沟通的桥梁;三个月后的你,也需要靠注释看懂今天的代码。

单行注释://

// 开始,到本行行尾结束,最常用:

// 这是单行注释
let age = 18;       // 行尾也可以加注释
console.log(age);   // 输出:18

多行注释:/* ... */

/* 开始、*/ 结束,可以跨多行,常用来写文件头说明,或临时屏蔽整段代码:

/*
 * 作者:张三
 * 功能:计算两个数的和
 */
let sum = 3 + 4;
console.log(sum);
// 输出:7

注释放在哪里

  1. 文件开头:说明作者、用途、创建/修改日期。
  2. 函数上方:说明函数的作用、参数和返回值。
  3. 复杂逻辑旁边:说明"思路"而不是翻译代码本身。
  4. 调试时:把某行代码"注释掉",临时停用它来排查问题:
let x = 10;
// x = 20;          // 先注释掉这行,观察运行效果
console.log(x);     // 输出:10

注释的常见坑

  • 字符串里的 // 不算注释,只是普通字符:
let url = "https://example.com";  // 这行的 // 才是注释
console.log(url);
// 输出:https://example.com
  • 多行注释不能嵌套:/* /* */ 在第一个 */ 处就结束了。
  • 不要写废话注释(如"这里给 x 赋值"),要写"为什么这么做"。

小结

// 是单行注释,/* ... */ 是多行注释,浏览器一律忽略。多写"为什么"、少写"是什么",注释才有价值。

笔记加载中…