1. 单行注释:
使用 // 符号,从 // 到行末的所有内容都被注释掉。
// 这是一个单行注释
let x = 5; // 这也是一个单行注释
2. 多行注释:
使用 /* 开始注释块,*/ 结束注释块,注释块中的所有内容都被注释掉。
/*
这是一个多行注释
可以跨越多行
*/
let y = 10;
/*
这是一个包含在代码中的多行注释
*/
3. 特殊注释:
有一些特殊的注释格式用于文档生成、调试等特定目的。
JSDoc 注释:
用于生成文档。例如:
/**
* 计算两个数的和
* @param {number} a - 第一个加数
* @param {number} b - 第二个加数
* @returns {number} 两个数的和
*/
function add(a, b) {
return a + b;
}
TODO 注释:
用于标记代码中需要完成的任务。
// TODO: 在下个版本中修复这个 bug
let bugFix = true;
DEBUG 注释:
用于标记调试信息。
// DEBUG: 输出变量的值进行调试
console.log(myVariable);
良好的注释可以提高代码的可读性,并帮助其他开发者理解代码的逻辑。在编写代码时,建议使用适当的注释方式,以便更好地组织和维护代码。
转载请注明出处:http://www.pingtaimeng.com/article/detail/3512/JavaScript