"烂代码"，7点建议
今天跟大家分享如何写好代码的几点建议，希望在写代码的时候能够提供一些帮助。
1、编码规范
每种编程语言、每个框架都有自己的一套编码规范和编码最佳实践方式，例如 PEP8 是 Python 语言的编码规范，作为 Python 开发者，每个人至少要将 PEP8 读上三五遍，熟记于心并运用在项目中。
2、文档注释
程序员最讨厌的两件事情：一，别人的项目没有文档和注释，二，自己的项目要写文档和注释。
经常看到一些项目连起码的 REAMDME 文件都没有，这跟demo没什么区别。如果你的项目没有文档，一旦有新人进来接手也是一脸懵逼，还显得非常业余。所以，一个正经的项目至少要说明项目的是做什么的，用了哪些东西，程序怎么跑起来等等。
简单的代码自然无需写注释，良好的代码自身就是文档和注释，但是如果有较复杂的代码逻辑就必须用注释来加以说明你当时写这段代码是如何思考的，否则隔两个月自己都不知道写的什么烂代码，还在骂这是哪个傻逼写的。所以，我们写注释应该在该写的时候才写，写多了或者写少了都不合适。还有一种情况就是过期的注释，需求变更代码更新后，发现注释还是旧的。