1. 注释不是越多越好。
2. 注释如果写不明白,或者和代码意思不一样,不如不写。
3. 尽可能采用代码自注释,即代码写得很明白,基本不用注释,一眼就能看明白。
4. 变量名和函数名尽量写得贴近生活,不需要注释。如果需要注释,先换个名字试试。实在无法从名字看出用途,再注释。
5. 一个函数或者一个类的有局限性,或者要说明用途时,用注释。
6. 当一个注释针对的代码有改动后,需要同步修改注释。
写代码注释的历程:几乎不注释 ---> 大量注释 ----> 关键注释。
建议学习一个好的写代码风格,需要注释才注释。
需要注释的地方一般是你自己定义的变量、函数等,还有一些不太好理解的算法可以注释一下便于后期代码的维护!