关于: 为什么要写注释----谈一下个人体会
注释:
好的代码应该像一本好书,读起来不仅让人涨知识,还能让人心情愉悦,而不应该像一坨shit,让维护和开发的人急于想要把它丢给别人。
1.要素
关键位置需要写注释,代码注释三要素:
*是什么、为什么、干什么
*好的注释应该自成体系,不应该 点击跳转到其他界面 才知道是什么。。。
*注释不仅是对 代码的说明,更是对 项目逻辑的梳理,把步骤写明之后,就可以填鸭式的编写代码。
2.规范
代码的编写应该规范, 该原则应该排在 优雅性 易读性原则之前,是最重要的原则。
还是那句话:规范具有通用性.
原创
2020-07-30 11:51:29 ·
700 阅读 ·
0 评论