如果注释只是一行文本,JavaScript解释器完全忽略了这一行。
通常添加注释是为了提供与源代码有关的额外信息,程序、参数说明等。
测试代码时,注释也可用于阻止或跳过执行。
单行注释
单行注释以双斜杠(//)开头,后跟注释文本。
// Print "Hello World" to the document
document.write("Hello World");
编写注释时,请在紧靠其下方的代码的同一级别缩进它们:
// 初始化函数
function showYear() {
// date object
let obj = new Date();
// 将当前年份存储在变量中 "myYear"
let myYear = obj.getFullYear();
// 使用以下命令将当前年份打印到HTML元素 ID="para"
document.getElementById("para").innerHTML = myYear;
}
当单行注释出现在代码行的末尾时,它们称为内联注释。
let x = 20;// 将数值分配给 x
let y = x + 5; // x + 5 赋值给 y
document.write(y); // 将变量y的值打印到文档
多行注释
多行注释或块级注释是用于介绍和解释一段代码的长格式注释。通常,这些类型的注释放在文件的顶部,或特别复杂的代码块之前。
多行注释以斜杠和星号(/*)开头,以星号和斜杠(*/)结束。
/* 初始化greetUser函数
将用户名分配给变量并打印出来
问候语句。. */
function greetUser() {
let name = prompt("你的名字叫什么?");
document.getElementById("output").innerHTML = "Hello " + name;
}
有时您可能还会看到块注释语法的略微修改版本,该注释语法/**以注释块左侧的开头并带有星号。
/**
*初始化greetUser函数。
*将用户名分配给变量
*并打印问候语。
*/
function greetUser() {
let name = prompt("你的名字是?");
document.getElementById("output").innerHTML = "Hello " + name;
}
块注释通常用于正式文档。
使用注释防止执行
注释还可以用于快速轻松地阻止出于测试和调试目的的代码执行。
// addTwoNumbers(5, 5);
multiplyTwoNumbers(6, 3);
单行注释和多行注释均可用于注释掉代码,具体取决于要切换的部分的大小。
/*
document.write("Hello World<br>");
document.write("Hello World<br>");
document.write("Hello World<br>");
document.write("Hello World");
*/
在确定程序的逻辑时,注释代码可以帮助您确定错误的位置或评估提供最多实用性的代码行。