1. 单行注释
使用//来添加单行注释,注释内容会从//开始一直到行尾。
// 这是一个单行注释
var x = 5; // 这是在赋值语句中的单行注释
2. 多行注释
使用/* */来添加多行注释,注释内容在/*和*/之间。
/*
这是一个
多行注释
*/
var y = "Hello";
/*
多行注释也可以
用于注释掉一块代码
*/
// var z = 10; // 这行代码被注释掉了
3. 注释的作用
1. 代码说明: 提供对代码功能、目的和实现方法的解释,方便自己和他人理解代码。
2. 调试: 可以通过注释掉或添加注释来调试代码,或者暂时排除一部分代码。
3. 文档生成: 注释可以用于生成文档,一些工具可以自动提取注释并生成代码文档。
示例
// 计算两个数字的和
function add(a, b) {
return a + b; // 返回两个数字的和
}
/*
多行注释示例
以下是一个对象,表示一个人的信息
*/
var person = {
name: "John",
age: 30,
// isStudent: true, // 这行注释可以用于排除 isStudent 属性
};
在编写代码时,良好的注释可以帮助提高代码的可读性和可维护性。然而,过度注释和不必要的注释也可能降低代码的清晰度,因此注释应该在需要解释和理解的地方使用。
转载请注明出处:http://www.pingtaimeng.com/article/detail/12777/JavaScript