一、js代码注释简介

1.1.js注释涵义;

1.1.1.js注释是js源代码文件中存在,解析时不会显示内容,只有查看源代码时才能看到的数据内容。

1.1.2.js程序员可以在查看源代码中看到。

1.1.3.网页中不会显示注释,所以普通用户是看不到的。

二、js代码注释写法

2.1.js注释有两种写法;

js注释分为单行注释和多行注释。

2.2.js单行注释;

2.2.1.js单行注释写法。

//html文件中
<script>
//  这里的注释的内容,在单行中,内容前放双斜线,该内容就会被注释掉。
//  alert("这个内容不会显示,因为被注释了,代码不会执行");
document.write("打印一个文件,代码后面的内容也会//被注释"); //这是输出内容到网页中;
</script>

2.2.3.在代码单行中,内容前放双斜线,该内容就会被注释掉。

2.2.4.单行注释代码双斜线(//)可以放在行首,也可以放在行中。

2.2.5.单行注释代码双斜线(//)后面的所有内容都会被注释掉。

2.2.6.上面的代码,页面中只会显示”打印一个文件,代码后面的内容也会//被注释”这个内容。其他注释都不会显示。

js代码注释效果图

2.3.js多行注释;

2.3.1.js多行注释写法。

//html文件中
<script>
/*function test() {
  return Math.random();
}
var a = test();
document.write(a);*/

</script>

2.3.2.在代码多行中,内容被放在符号/* 和 符号*/的中间,该内容就会被注释掉,如上面的代码。

2.3.3.常见的错误注释:

多行注释代码(/**/)只要是符号/*  和 符号*/中间的所有内容,不管多少行都会被注释掉 。注意: 这两个符号注释的内容不允许有这个符号(*/)。如下面的代码

//html文件中
<script>
/*function test() {
  return Math.random();
}
var a = test();*/
document.write(a);*/

//

/*
* jQuery JavaScript Library v3.3.1
* https://jquery.com/
*
* Includes Sizzle.js
* https://sizzlejs.com/
*
* Copyright JS Foundation and other contributors
* Released under the MIT license
* https://jquery.org/license
*
* Date: 2018-01-20T17:24Z
*/
</script>

2.3.4.结果如下图:解析:上面的代码结果是:document.write(a)*/ 这个代码没有被注释,并且会引起语法错误(控制台提示),页面中没有输出a的值,正常的代码document.write(a)都不会执行了。因为后面的符号(*/)无法被识别。

多行注释容易发生的错误

2.3.5.多行注释经常会被这样写,代码如下。

//html文件中
<script>
/*
* jQuery JavaScript Library v3.3.1
* https://jquery.com/
*
* Includes Sizzle.js
* https://sizzlejs.com/
*
* Copyright JS Foundation and other contributors
* Released under the MIT license
* https://jquery.org/license
*
* Date: 2018-01-20T17:24Z
*/
</script>

2.2.6.符号(/*)占一行,符号(*/)也占一行。中间的内容每行写一句话。放在在行首加一个符号(*),这样写代码会更整洁。上面的代码是选自jquery.js源文件的第一个注释内容。用来表示jquery的一些基本信息。开发项目时常用这种方法。

三、js代码注释的意义

1.1.js注释可以帮助程序员更好的记忆自己的代码并且维护它;

1.2.js注释可以让代码更直观,看着更清爽;

1.3.js注释让程序员调试代码更方便;

博主联系方式:

  • 微信:34419369
  • QQ: 34419369
  • 公众号:前方录
  • 有什么不懂的地方欢迎联系我,帮到你是我会很开心

Leave a Reply

电子邮件地址不会被公开。 必填项已用*标注