Rumah >hujung hadapan web >tutorial js >深入理解JS代码注释方法及代码注释规范

深入理解JS代码注释方法及代码注释规范

yulia
yuliaasal
2018-10-10 14:35:529301semak imbas

在页面布局时,为了提高代码的可读性,经常需要给代码加注释,这篇文章就和大家聊聊JS怎么注释代码以及JS代码注释的规范,感兴趣的朋友可以参考一下,希望对你有所帮助!

注释是代码必不可少的一部分,一个完整的程序必须要加注释。注释不仅有利于自己更新和修改项目,还有利于其他人拿到你的项目时知道你写的什么。

一、JavaScript代码注释方法

JavaScript不会执行注释里面的代码,JS代码注释分为单行注释和多行注释。

1、单行注释

单行注释以//开头,//后面要加一个空格,然后再写注释的内容,单行注释可用于描述当前代码的作用,解释代码等等。

代码实例:给document.write("字符串是:"+str)代码单行注释,不需要其显示在页面上

<script type="text/javascript">
  function myFunction(){
   var animal = ["dog", "cat", "elephant", "tiger"];
   var str=animal.toString();
   document.write("类型是:"+typeof(str));  
   //document.write("字符串是:"+str)
  }  
 </script>

注释前效果图:

图片5.jpg

注释后效果图:

图片6.jpg

2、多行注释

多行注释以 /* 开始,以 */ 结尾,但是工作中要尽量使用单行注释替代多行注释,即使注释需要多行,也要用单行注释来完成,但是函数的注释还是推荐使用多行注释。

代码实例:

<script>
/*
下面的这些代码会输出
一个标题和一个段落
并将代表主页的开始
*/
document.getElementById("myH1").innerHTML="欢迎来到菜鸟教程";
document.getElementById("myP").innerHTML="这是一个段落。";
</script>

二、JS代码注释的规范

一个好的代码注释要做到,如果没有必要,则不要加注释,如果需要加注释,则写详细,让别人明白你的意思,尽量提高代码的清晰性和可读性。工作中要做到以下几点:

1、在有逻辑的代码中,代码的注释要在20%以上

2、文件注释时,文件注释写入文件的头部

3、类和接口的注释时,注释需要放在class之前,using或package关键字之后

4、遇到类属性、公有和保护方法时,注释需要写在类属性、公有、保护方法上面。即用//注释,需要对齐被注释的代码

5、注释需要放在被注释的代码前面,分行写且中间不要留空行

6、不要在注释中使用缩写,如果要用缩写,需要对缩写进行必要的解释说明

7、成员变量注释内容时,成员变量的意义、目的和功能,可能被用到的地方,用//来注释,需要对齐被注释的代码

总之,每个程序员都应该养成一个写注释的好习惯,不仅方便自己阅读和修改代码,而且还方便别人理解和维护你的代码。

以上介绍了JS代码的注释方法以及JS代码的注释规范,比较简单,容易理解,更多相关教程请访问 JavaScript视频教程

Atas ialah kandungan terperinci 深入理解JS代码注释方法及代码注释规范. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan:
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn