【js】如何正确的写代码注释？

这篇具有很好参考价值的文章主要介绍了【js】如何正确的写代码注释？。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

【js】如何正确的写代码注释？,其他,前端,javascript,开发语言

✍️ 作者简介: 前端新手学习中。

💂 作者主页: 作者主页查看更多前端教学

🎓 专栏分享：css重难点教学 Node.js教学从头开始学习 ajax学习
前端面试题

错误注释

你的注释是不是这样的？

//时间戳日期格式化函数
  
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){
            
   }

是不是比之前的注释多了很多，内容详细了很多，当然，不只是单单的内容多了，如果只是内容多了那么/* */段落注释同样也可以写，那么它还有什么优点呢？