提高代码可读性与维护性

JavaScript 注释：提高代码可读性与维护性

注释是编程中不可或缺的一部分，它们帮助开发者解释代码逻辑、临时禁用代码段或提供额外的信息。JavaScript 支持两种主要的注释方式：单行注释和多行注释。

单行注释

单行注释使用两个连续的斜杠 // 开始。在 // 之后直到行尾的所有内容都会被 JavaScript 解释器忽略。

单行注释的代码示例

// 这是一个单行注释
let message = 'Hello, World!'; // 这行代码创建了一个字符串变量
console.log(message); // 这行代码将输出变量的值

多行注释

多行注释使用斜杠加星号 /* 开始，星号加斜杠 */ 结束。在这个区间内的所有内容都会被忽略，无论它们占多少行。

多行注释的代码示例

/*
这是一个多行注释
它可以跨越多行
解释器同样会忽略它们
*/
function greet() {
   
    console.log('Hello!'); // 这行代码将输出问候语
}

JavaScript 数据类型的注释

数据类型是编程语言中定义数据的分类方式。JavaScript 是一种弱类型或动态类型语言，其数据类型可以分为两大类：原始数据类型（Primitive Data Types）和引用数据类型（Reference Data Types）。

原始数据类型

• Undefined: 没有指定值时的默认类型，例如 let age;
• Null: 表示故意赋予变量的空值，例如 let car = null;
• Boolean: 逻辑实体，只有两个值：true 或 false
• Number: 表示数值，包括整数和浮点数
• BigInt: 表示大于 2^53 - 1 的整数
• String: 表示文本数据，由字符组成的序列
• Symbol: 表示一个唯一的、不可变的数据类型，ES6 新增

引用数据类型

• Object: 包括对象、数组、函数等

代码示例

以下示例展示了如何在定义不同数据类型的变量时使用注释：

// 原始数据类型示例
let undefinedVar; // 类型 Undefined
let nullVar = null; // 类型 Null
let booleanVar = true; // 类型 Boolean
let numberVar = 42; // 类型 Number
let bigIntVar = 1234567890123456789012345678901234567890n; // 类型 BigInt
let strVar = "This is a string"; // 类型 String
let symbolVar = Symbol('mySymbol'); // 类型 Symbol

// 引用数据类型示例
let arrayVar = [1, 2, 3]; // 类型 Object（数组）
let objVar = {
    name: 'Kimi', age: 1 }; // 类型 Object
let funcVar = function() {
    console.log('Hello!'); }; // 类型 Object（函数）

// 打印变量类型
console.log(typeof undefinedVar); // 输出 "undefined"
console.log(typeof nullVar); // 输出 "object"（这是一个历史错误）
console.log(typeof booleanVar); // 输出 "boolean"
console.log(typeof numberVar); // 输出 "number"
console.log(typeof bigIntVar); // 输出 "bigint"
console.log(typeof strVar); // 输出 "string"
console.log(typeof symbolVar); // 输出 "symbol"
console.log(typeof arrayVar); // 输出 "object"
console.log(typeof objVar); // 输出 "object"
console.log(typeof funcVar); // 输出 "function"