JavaScript注释规范
注释写得好，维护少不了。JavaScript 的注释规范真的是前端人手一本的“小秘籍”。不管你写的是业务逻辑还是工具函数，注释没跟上，过段时间连自己都看不懂。
模块开头用/** ... */来写功能，顺手标个作者和日期，团队协作更顺畅。像下面这样写挺规范的：
/**
* 用户登录模块
* 包含表单验证、求发送等逻辑
* @author Ethan
* @date 2024-04-12
*/小函数别乱丢，归类注释一下，看着清楚多了。方法上方那段注释也不能省，@param、@returns这些写清楚，别人调你方法才不一脸懵。
变量也别放飞，尤其是那种一行声明仨变量的，最好每个前面都备注一句，像：
// 商品名字
var name = $(item).find('.js-name').val();还有，复杂代码段前加个/* */注释逻辑，说不定下次救你一命。注意格式统一，缩进别乱来，if、forEach这种结构看起来才舒服。
如果你平时写注释只是图快，那建议好好学一下这套规范。代码自己写爽，别人看更轻松，维护起来事半功倍。
文件大小：43.44KB
评论区