0

0

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

yulia

yulia

发布时间:2018-10-10 14:35:52

|

9874人浏览过

|

来源于php中文网

原创

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

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

一、JavaScript代码注释方法

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

1、单行注释

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

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

注释前效果图:

图片5.jpg

注释后效果图:

图片6.jpg

2、多行注释

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

代码实例:

Magician
Magician

Figma插件,AI生成图标、图片和UX文案

下载

二、JS代码注释的规范

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

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

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

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

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

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

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

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

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

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

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

553

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号