“代码千万行，注释第一行；编程不规范，同事两行泪”

程序员最讨厌哪四件事？

没错，就是——写注释、写文档、别人不写注释和别人不写文档。

因此，在《流浪地球》刷屏之后，仿其而出的“代码千万行，注释第一行；编程不规范，同事两行泪”（来自CSDN公众号）就在技术圈传播起来，由此可见，规范对于编程是多么的重要。

其实这些事情都是可以被解决的，只要在开发时能做到以下几点，想必你也能像“户口”那样，在纷乱的代码海洋中翱翔。

一、在协作开发时，使用版本控制工具

感谢Linus，Git的出现让协作开发变得异常简单，如果离开了Git，版本的控制将会变得异常艰难。

想像一下，只要动动手指，就能把不同的版本合并到一起是多么的简单，如果没有版本控制工具，我们的行动将会变得举步维艰。

如果没有版本控制工具，我宁肯不参与这个项目。

二、使用合适的变量名

想象一下，OneDeng_Price、Deng_Price、ThreeDeng_Price（一等奖、二等奖、三等奖，奖的英文还拼错了）以及苹果手机是apple_sj，Android手机是android_sj这样的变量名大量的出现在程序中，你做为同事难道不是泪流两行吗？

搞笑变量名

作为程序员我们要注意，适当的命名，对程序的可读性和开发效率有着极大的加成。我这有一个小技巧——变量名要做到可以自解释，即当你看到他的时候，就知道他的用途，但也不要使用太长的变量名。一般来说，已8个字母为限度，最多不能超过16个字母。

三、适度的使用依赖

GitHub和码云上有很多非常不错的开源项目，躲到我们数不清，而它们涵盖了各个领域——达到航天飞机的开发工具，小到智能马桶的控制程序，生活中能想到的源码在上面都能找到。这让我们的工作更加容易，节约了宝贵的时间。

但是，使用过多的依赖库会给整个项目带来风险——比如前一段时间的Ant Design 的圣诞节彩蛋，以及MangoDB突然改变的许可协议，种种因素，会使程序变得越来越不可控。

所以，在使用第三方依赖库之前，我们要仔细想想，是否必须使用它。

四、给自己的代码写注释

没有人希望在一个上百万行的开发中，阅读玩全部代码后才能知道某段代码想要实现的功能。唯一的办法就是给代码加上适当的注释。

当然，也不要过多的写注释

c = a + b #把a+b的值赋给c

这样的注释，会让任何一个共同开发的同事怀疑他的智商。

五、格式要一致

格式也会对可读性和生产效率带来巨大的影响，在项目中，选择一个特定的命名规范并一直坚持下去，不要在中途改变它们。我个人更喜欢用小写字母来命名文件（Windows有时候会把文件变成小写），驼峰命名法来命名方法、变量等。但这些也会根据不同的语言而作出改变。

此外，我们还应该使用相同的缩进格式，要使Tab都使Tab要使用空格，都使用空格，这点Python的要求更加严格，不统一的缩进直接无法编译通过。

六、一定要处理错误

畏惧它。逃避它。Bug 终会降临！ —— 灭霸

无论你是多么优秀的程序员，你的代码都会出现问题，除非你写的是print('Hello world')

这些错误有可能是因为 API 错误引起的，也有可能是超时，类型错误，空值，或者只有鬼知道的原因。通常，这些会让你的代码出现问题。

在不同的语言中，处理错误的方式有很大的差异。但是一般情况下，在访问数据之前都需要判断数据否为空。在我的经验中，空指针比其它错误都多。

所以，在执行数据处理的相关需求时，建议将代码放到 try-catch 中，并处理对应的异常，最后，不要忘记告诉用户哪里出现了问题。如果在用户按下按钮和按键的时候不给用户反馈，用户将不知道发生了什么。给用户错误提示，并告诉它下一步怎么做。

七、绝不使用不当的数据类型/数据结构

在不同的语言中，数据类型要求不一样，强类型语言非常严格，而弱类型可以随意使用。强类型语言在编译时就会告诉你错误，而其它语言需要在运行时，才能知道错误。

举个例子，我们将数值存储在整型/符点型/双精度符点型的变量中，并且与存储在字符串中的变量进行比较时，有的语言会进行自动类型转换，然后进行比较，而有的语言并不会。

八、结语

你认为还有什么需要加在这个列表里面，在评论中写出来，让我知道。

Happy Coding!

最后送福利了，现在加群即可获取 Java工程化、高性能及分布式、高性能、高架构、性能调优、Spring、MyBatis、Netty源码分析等多个知识点高级进阶干货的直播免费学习权限及相关视频资料，还有spring和虚拟机等书籍扫描版

群号：923116658

点击链接加入群聊【Java架构解析】：https://jq.qq.com/?_wv=1027&k=5e1QsXb