单行注释
两个正斜杠 (//) 用于编写单行注释:
//单行注释
JavaScript 将忽略(不会执行)斜线和行尾之间的任何文本。
请参阅此示例,该示例在每个代码行之前使用单行注释:
例子
<!DOCTYPE html> <html> <head> <title>JavaScript单行注释</title> </head> <body> <h2 id="myHeading"></h2> <p id="myParagraph"></p> <script> //For heading document.getElementById("myHeading").innerHTML = "JavaScript单行注释"; //For paragraph document.getElementById("myParagraph").innerHTML = "JavaScript注释"; </script> </body> </html>
当单行注释出现在一行代码的末尾时,它们被认为是行内注释。
为了对小的、特定的内容片段进行快速注释,可以使用内嵌注释。
由于注释应仅与所写的确切行相关,因此它是最明显的注释类型。
例子
let a = 55; //assign numerical value to a let b = a + 4; //assign the sum of a + 4 to b //Write b to demo: console.log(b);
请记住,无法在一行上结束单行注释,因此请确保不要在 //语法之后放置任何代码。
尽管内联注释可能有用,但应谨慎使用。
被大量内联注释覆盖的代码很容易变得混乱,难以阅读。
在测试替代代码时使用注释阻止执行
注释可用于轻松快速地阻止代码执行以进行测试和调试。
这叫做“注释掉代码”。
在代码行前面添加 //会将代码行从可执行行更改为注释。
当我们编写的特定代码中出现错误时,对部分进行注释将阻止它们运行,并且有助于确定问题的根源。
要测试不同的结果,我们还可以使用它在代码之间切换。
请参阅使用 //阻止执行其中一行代码的示例:
例子
<!DOCTYPE html> <html> <head> <title>Multi-line JavaScript Comments</title> </head> <body> <h2>JavaScript Comments to Prevent Execution </h2> <h1 id="myHeading"></h1> <p id="myParagraph"></p> <script> /* document.getElementById("myHeading").innerHTML = "Welcome to onitroad"; document.getElementById("myParagraph").innerHTML = "js注释"; */ document.getElementById("myParagraph").innerHTML = "经历过风雨,才懂得阳光的温暖。"; </script> </body> </html>
根据要切换的部分的大小,可以使用单行注释和块注释来注释代码。
当我们确定错误所在或者评估提供最多效用的代码行时,在制定项目逻辑时注释掉代码会很有用。
注释掉代码应该只在测试期间进行。
不要在最终脚本中留下注释掉的代码片段。
计算机会解释 JavaScript 代码,但其他开发人员将始终阅读它,将来也会为自己阅读。
不要后悔在复杂的代码部分放弃常规注释将是未来的一个优势,使我们和同事更容易理解我们编写的代码的目的。
多行注释
多行注释,广为人知的块注释,以 /* 开头,以 */结尾。
如果我们了解 CSS,那么我们已经熟悉块级注释。
JavaScript 将忽略 /* 和 */之间的任何文本。
/* JavaScript 多行注释*/
单行和多行注释都写在代码上方以阐明代码。
看一个使用多行注释(一个注释块)来简化代码的例子:
例子
<!DOCTYPE html> <html> <head> <title>Multi-line JavaScript Comments</title> </head> <body> <h1 id="myHeading"></h1> <p id="myParagraph"></p> <script> /* 这是多行注释 注释将会被解析器忽略 */ document.getElementById("myHeading").innerHTML = "多行注释示例"; document.getElementById("myParagraph").innerHTML = "js多行注释示例"; </script> </body> </html>
请注意,最常见的是使用单行注释。
块注释通常用于正式文档。
它们有时会包含有关编程文件的详细信息,包括脚本的名称、版本和作者。
编程中的第一个关注点通常是机器如何读取代码并解释它。
事实上,考虑到将阅读和使用代码的人是非常重要的。
无论我们是应该与团队合作还是独自工作,都需要学习如何为读者适当地注释和构建代码。
注释是解释器忽略的程序源代码中的注释,因此不会影响代码的实际结果。
注释通常对理解代码部分的目的非常有帮助。
作为一名开发人员,深入查看其他人编写的没有适当注释的代码可能会很烦人,而且当我们不再参与该项目时,很容易忘记代码的实际意图。
如果你在正确的时间正确地注释你的代码,它将成为一个良好的编程习惯,你将避免未来的误解。
有一句著名的陈词滥调是“好的代码是自我记录的”。
而且当你开始一个新项目时,你应该考虑一下你的代码的澄清和文档,这可以通过注释来完成。
JavaScript 注释可以通过两种方式使用:澄清 JavaScript 代码并使其更易于理解;以防止在测试替代代码时执行。
有两种不同类型的 JavaScript 注释:
- 单行注释
- 多行注释