写前端的时候我们要如何做好注释?
当我们写代码的时候有时候会思如泉涌,哐哐哐的不停的写,写得又好又流畅,bug也少。
但是当我们过一段时间,再来看自己的代码的时候,往往又发现,自己写的是什么?怎么一点思路也没有了,为什么要有这个方法?为什么要这么跳转,为什么要这样判断,完全想不起来了。
这就需要我们写代码的时候要做好注释。
规范的注释让自己改代码的时候事半功倍。
无论过多久再去看自己的代码,依然知道自己的写的是什么。
这样不仅仅是方便自己,同样是方便他人来维护代码。
今天我就告诉大家如何优雅的进行代码注释。
一、前端的dialog写明详细的作用,以及开始和结束
<!-- 新增 添加或修改信息对话框 新增 开始 -->
<!-- 新增 添加或修改信息对话框 新增 结束 -->
<!-- 事件描述 开始 -->
<!-- 事件描述 结束-->
二、前端画页面的时候把每一行给标注出来
<!-- 第一行开始 -->
<!-- 第一行结束 -->
<!-- 第二行开始 -->
<!-- 第二行结束 -->
三、前端每个方法都写清楚作用