注释是个好东西,但是也要分场合。
对于我来说,我自己可以不写注释,因为我自己看得懂,但是你必须要写,你不写我看不懂。
一连串的哈哈哈哈!!
第一,亲身经历
我们都应该明白,去工作自己写的代码根本不多,都是去维护公司以前的项目代码。
那么对于新接触的项目代码怎么快速了解呢?最简单的就是看注释了,所以有一个好的注释习惯对于别人来说是事半功倍的。
至今,我已经毕业一年多了,工作也差不多一年了。
我刚来到这个公司的时候,那代码我是真的看不懂,也不知道是什么意思,完全就是自己猜测着来的,好在变量命名还是英文的,不是那种a,b,c,d之类的。
由于是公司的项目代码,不便粘贴出来,以前那垃圾代码就不给大家见笑了。
说到注释了,那么对于变量命名也要易于理解,用对应的英文去命名,即使是拼音也好,它起到的意义和注释是一般无二的。
由于老工程师写的项目代码没有注释,写的也不标准,我光看代码理解看了快一个月,看到头都大了,然后自己看着,猜着,自己逐步注释下来。我刚来,老工程师就辞职了,连个交接都没有,所以没有注释是真的难受。
第二,不写注释的原因
我觉得不写注释的原因完全就是因为嫌麻烦,还有就是自己写的代码自己明白是什么意思,觉得没必要写。如果问我,我还会说:我英语不好,笑死有没有。这是为什么呢?因为写的中文注释,在不同的编码下会出现乱码,看起来很难受,但又英语不好,我就想不想注释,反正我每次写注释都是翻译着写的。
第三,写并且如何写出好的注释
不要长篇大论的写,关键的地方点睛一下即可。
变量命名规范,根据名字就可以看懂它的意思。
我一般喜欢在定义变量的时候加一下注释。
总之,注释要写,但是写不写还是看自己。就像别人说的,在一个公司里,我不写注释它离不开我。