代码注释
1. 注释的目的是提升代码可读性。
2. 变量名不能完美说明代码做了什么时，可用注释补充。
3. 代码较复杂时，可在注释中说明实现思路，作为具体实现的总结。
4. 完整的规范的注释可直接当成文档。注释可说明代码“为什么，做什么，怎么做，如何用”。
5. 注释本身有维护成本。如果代码改了但注释忘了同步修改，会让代码阅读者更加迷惑。
6. 代码越多，需要写注释越多，比如类，模块。函数需要的注释相对少一些，可以靠好的命名、提炼函数、解释性变量来提高代码可读性。
展开
今天学到了
avatar
avatar
avatar
等人赞过
7
相关推荐