JavaScript如何正确的写代码注释
更新时间：2023年10月07日 15:35:50 作者：坚毅的小解同志
这篇文章主要给大家介绍了关于JavaScript如何正确的写代码注释的相关资料,注释的作用是提高代码的可读性,帮助自己和别人阅读和理解你所编写的JavaScript代码,注释的内容不会在网页中显示,需要的朋友可以参考下
错误注释
你的注释是不是这样的？
//时间戳日期格式化函数
function formTime(time,isyear){
}亦或者是这样的？
/*
时间戳日期格式化函数
*/
function formTime(time,isyear){
}简单的变量声明之类的内容可以进行简单注释，但是函数就不能这样做了，要知道注释的作用是一种为了让代码更易读、易维护、易理解，起到提示的作用的，上面的两个注释都是正确的，但是它起到的作用太低了，在正式工作中我们往往会协同开发，这种注释是万万不可的。
正确注释
正确的注释 就是文档注释，先来看看是什么样子。
/**
* @author 小解同志 https://lamian.blog.csdn.net
* @param {String} time 接受用户传来的时间戳
* @param {Boolean} isyear 是否要显示年月日
* @example formTime('3434322332',true) 格式化时间戳并显示年月日
*/
function formTime(time,isyear){
}是不是比之前的注释多了很多，内容详细了很多，当然，不只是单单的内容多了，如果只是内容多了那么/* */段落注释同样也可以写，那么它还有什么优点呢？
优点
方法提示
time是个字符串 我们要截取字符串
普通注释
文档注释
内容提示
鼠标移动到函数以及参数上所给的提示。
普通注释
文档注释
这种提示就像嵌代码在里面一样，而不是浮于表面了，在我们书写npm包的时候，用户使用我们的包，就能看到这种提示，对使用者特别友好。
自动化生成文档
既然叫文档注释，那么生成个文档也没什么好奇怪的吧，生成文档的包有很多种，比如jsDoc，apiDoc等等，在这里我使用jsdoc。
安装
输入以下命令进行全局安装。
npm install jsdoc -g
基本使用
jsdoc 文件名 其他的使用方式可以去官网查看
jsdoc 33.js
执行完此命令，会生成一个out文件夹，查看里面的index页面即可，右边侧边栏会显示函数的使用
总结
到此这篇关于JavaScript如何正确的写代码注释的文章就介绍到这了,更多相关js正确写代码注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了JavaScript设置body高度为浏览器高度的方法,实例分析了body高度的设置技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-02-02
这篇文章主要介绍了js传各种类型参数到Controller层的整理方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-02-02
DHTML form validation...2007-03-03
这篇文章主要介绍了Javscript调用iframe框架页面中函数的方法,可实现iframe之间传值或修改值,是非常实用的技巧,需要的朋友可以参考下2014-11-11
Bootstrap 提供了一些辅助类，以便更快地实现对移动设备友好的开发。这些可以通过媒体查询结合大型、小型和中型设备，实现内容对设备的显示和隐藏。下面通过本文给大家分享Bootstrap 响应式实用工具，一起看看吧2017-03-03
这篇文章主要为大家详细介绍了javascript实现全屏页面滚动效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-10-10
这篇文章主要介绍了js计算德州扑克牌面值的方法,实例分析了javascript计算扑克面值的算法技巧,需要的朋友可以参考下2015-03-03
这篇文章主要为大家详细介绍了jquery实现左右滑动式轮播图，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2017-03-03
这篇文章主要给大家介绍了关于JavaScript数组去重的几种方法，文中通过示例代码介绍的非常详细，对大家学习或者使用JavaScript具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-04-04
这篇文章主要介绍了js之切换全屏和退出全屏实现代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-09-09
最新评论