在JavaScript中,为一些关键代码注释是非常有必要的。注释的好处很多,比如方便理解、方便查找或方便项目组里的其他开发人员了解你的代码,而且也方便以后你对自己的代码进行修改。
一、单行注释
当注释的内容比较少,只有一行时,我们可以使用单行注释的方式。
语法:
//单行注释
说明:
小伙伴们要特别注意一下,HTML注释、CSS注释和JavaScript注释是不一样的。此外,并不是什么地方我们都要注释,一般情况只会对一些关键功能的代码进行注释。
举例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title></title>
<style type="text/css">
/*这是CSS注释*/
body{color:Red;}
</style>
<script>
//这是JavaScript注释(单行)
document.write("不要把无知当个性");
</script>
</head>
<body>
<!--这是HTML注释-->
<div></div>
</body>
</html>
浏览器预览效果如图所示。
分析:
从上面我们可以知道,被注释的内容是不会在浏览器中显示出来的。
二、多行注释
当注释的内容比较多,用一行表达不出来时,我们可以使用多行注释的方式。
语法:
/* 多行注释 */
说明:
有小伙伴可能会说,HTML、CSS、JavaScript注释不一样,而JavaScript还分单行注释和多行注释,我都记不住啊!其实我们不需要去死记,稍微留个印象就可以了,因为开发工具都会有代码高亮的提示功能。平常要是忘了的话,在编辑器中测试一下就知道了。
举例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title></title>
<script>
/*
这是JavaScript注释(多行)
这是JavaScript注释(多行)
这是JavaScript注释(多行)
*/
document.write("不要把无知当个性");
</script>
</head>
<body>
<div></div>
</body>
</html>
浏览器预览效果如图所示。
分析:
当然,如果注释的内容只有一行,我们也可以采用多行注释方式。