关于： 为什么要写注释----谈一下个人体会

注释：

好的代码应该像一本好书，读起来不仅让人涨知识，还能让人心情愉悦，而不应该像一坨shit,让维护和开发的人急于想要把它丢给别人。

1.要素

关键位置需要写注释，代码注释三要素：

*是什么、为什么、干什么

*好的注释应该自成体系，不应该 点击跳转到其他界面 才知道是什么。。。

*注释不仅是对 代码的说明，更是对 项目逻辑的梳理，把步骤写明之后，就可以填鸭式的编写代码。

2.规范

代码的编写应该规范， 该原则应该排在  优雅性 易读性原则之前，是最重要的原则。

还是那句话：规范具有通用性，即使该方法很笨，很不优雅，而不同的编程语言对优雅性和易读性却有不同的要求。

模块化虽然更加清晰简洁，但是会降低 第三方阅读的逻辑性。。

3.为什么写注释

自己的代码很熟悉了， 为什么还要多写注释？

注释其实可以是对自己代码思路的整理，我们平时没时间整理，那就可以写在代码里，以方便以后在技术周报或者其他地方使用，还可以总结自己的技术点，对于平时没时间或者用过就忘的我们来说是非常重要的。

4.注释量大小

优秀的代码的注释量会有三分之一甚至达到二分之一。这个可以参考各个大厂SDK的使用说明，大量的注释是代码模块化的基础，可以在不同的程序员间无障碍使用，基本不会有离职后项目就无法开发的问题。建议建立公司代码库