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正确写代码注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
写suggest的时候，有时我们快速删除输入框的文字后，但是suggest下拉列表还有出现，导致的原因是因为ajax异步请求造成的，下面通过本文给大家分享下解决方法，感兴趣的朋友一起看看2016-12-12
今天给大家分享一个特别有意思的软件卸载对话框功能，本段代码是基于js 与css实现的，感兴趣的朋友跟随小编一起看看吧2019-12-12
下面小编就为大家带来一篇基于js 本地存储(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-08-08
这篇文章主要介绍了JavaScript ES5标准中新增的Array方法 的相关资料,需要的朋友可以参考下2016-06-06
javascript实现划词标记划词搜索功能修正版...2006-12-12
本文通过实例代码给大家介绍了JS中NEW的实现原理及重写，本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友参考下吧2020-02-02
一个基于 Js + Canvas 的大转盘和九宫格和老虎机抽奖，使用lucky-canvas 功能可以自由配置，多端适配的特点，本文通过实例代码给大家详细介绍抽奖方法，感兴趣的朋友一起看看吧2022-06-06
递归是算法中一个重要的解法,因此,有必要单拎出来讲讲,所以下面这篇文章主要给大家介绍了关于JavaScript递归经典案例题的相关资料,需要的朋友可以参考下2021-07-07
这篇文章主要介绍了微信小程序跨页面传递data数据方法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-12-12
这篇文章主要介绍了bootstrap表单样式的使用，本文介绍的非常详细，具有参考借鉴价值，感兴趣的朋友一起看看吧2016-09-09
最新评论