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正确写代码注释内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！