JavaScript注释

定义

JavaScript 注释用于解释 JavaScript 代码，增强其可读性。它不仅能帮助开发者理解代码的功能和逻辑，还能在团队协作中提高代码的可维护性。

单行注释

单行注释以 // 开头。

任何位于 // 与行末之间的文本都会被 JavaScript 忽略（不会执行）。

// 改变标题：
document.getElementById("myH").innerHTML = "我的第一张页面";
// 改变段落：
document.getElementById("myP").innerHTML = "我的第一个段落";

多行注释

多行注释以 /* 开头，以 */ 结尾。

任何位于 /* 和 */ 之间的文本都会被 JavaScript 忽略。

/*
	下面的代码会改变网页中
	id = "myH" 的标题
	以及 id = "myP" 的段落
*/
document.getElementById("myH").innerHTML = "我的第一张页面";
document.getElementById("myP").innerHTML = "我的第一个段落"; 

文档注释

文档注释以 /** 开头，以 */ 结尾。

通常用于描述函数、类、模块等的用途和参数，可以被工具解析生成文档。

/**
 * 计算两个数的和
 * @param {number} a  第一个加数
 * @param {number} b  第二个加数
 * @returns {number}  两个数的和
 */
// 定义一个函数add，接收两个参数a和b
function add(a, b) {
    // 返回a和b的和
    return a + b;
}

/**
 * 查找数组中的最大值
 * @param {number[]} arr  数组
 * @returns {number}  最大值
 */
// 定义一个函数，用于找到数组中的最大值
function findMax(arr) {
    // 如果数组为空，抛出错误
    if (arr.length === 0) {
        throw new Error("Array is empty");
    }
    // 初始化最大值为数组的第一个元素
    let max = arr[0];
    // 遍历数组，从第二个元素开始
    for (let i = 1; i < arr.length; i++) {
        // 如果当前元素大于最大值，则更新最大值
        if (arr[i] > max) {
            max = arr[i];
        }
    }
    // 返回最大值
    return max;
}