前言

从成为社畜开始写代码到现在也有两年了，两年期间，大尾巴狼一直在一家小公司工作。虽然本人的经验和技术都算不上特别好，学历也仅仅只是专科，但两年的时间，也经历了一些事情。最近公司的新人也不少，看着他们犹如看见了曾经的自己（然后一步步的走过我踩过的坑）。今天呢，大尾巴狼想趁现在有点时间分享一些开发时应该养成的好习惯。

文档

为什么我把文档放在最前面呢？原因很简单，一个好的文档，可以避免很多麻烦，让开发人员把更多的精力集中在开发上，让客户更快的验收。

那么文档要包括什么呢？最起码要有被客户确认过需求文档，而一个需求文档里最低也要有模块的业务逻辑、交互效果、数据结构。老实说，这些东西有些客户可能压根不会看，但如果没有文档，在项目验收时，应该以什么为标准进行验收呢？

代码

注释，无论如何都要有注释。

注释可以帮助我们整理思路，表达写这段代码的意义或逻辑。这样后续进行维护时可以更舒适地把精力放在优化、更改上，不用浪费更多的时间精力去再想一遍逻辑。

命名规范

不论是方法、还是变量，一定要有命名规范并严格遵守。没有命名规范的代码，长时间后你自己再看，会有一种感觉“这是一坨什么？”而且遵守规范，也方便后续的维护。

写代码的注意事项

循环拒绝嵌套太多。
同一个功能（比如消息提醒），多个模块都使用，尽量抽成一个公用的方法或类。
能通过sql语句实现的，在服务器配置支持的情况下尽量通过sql解决。
循环中不要多次执行相同的io流。
慎用新技术。
切忌不要一次提交大量的代码和文件。最好一个模块弄好、测好后提交。