学编程，先知规范

我为什么要写这篇博客

写博客一直是我想去做的事，可是一直没有付诸于行动。虽然看别人的博客很容易，但当自己开始在键盘上敲打的时候，我发现太痛苦了。

八月初，和我同一批校招进厂的同学们都已上岗工作了。因为我们的水平不太统一，有的基础好点，有的基础差点，所以老大每周会给我们布置作业，同时也会对我们的作业进行讲评。经过最近两次作业，我发现有部分同学的编码规范有待提高。其实这也可以理解，因为他们之前没有接触过，在学校的时候也没人告诉他们编码要讲究规范。

我是四月份进的厂，老大安排我维护两个系统。当我看见系统的源码的时候，我的心里有着一万匹叫做曹里的马在奔腾。包含几百行代码的方法随处可见；一个方法有几十个形式参数是正常现象；各种代码风格混杂在一起特别杀马特；在JSP里掺杂着 Java、JS、HTML、CSS 代码，有种 56 个民族一家亲的味道；整个系统有一半的逻辑是写在存储过程里的，先喝口水压压惊。

其实公司老系统代码令人恶心的一个很重要的原因就是上梁不正，下梁歪。由于刚进来的新人也不分不清代码风格的好坏，他们只能学着前人的风格。这样的恶性循环非常可怕。我希望所有学习编程的同学，从开始就养成一个非常好地编码习惯。

高级程序语言诞生的目的

我们现在接触到的绝大多数编程语言都是高级语言，例如： C、C++、Java、JavaScript 等。我们在这里不论各种高级程序语言的优劣。

我们一定要铭记，用高级语言写出来的代码是给人看的。我相信高级语言诞生时最宏伟的一个目标就是：即使没有学过编程的人，他们可以通过类名、方法名和变量名大概知道程序的功能。

像写好一篇文章一样写代码

我相信一篇优秀的文章，一定是内容精彩，同时字迹漂亮，文章格式人性化。如果一篇文章的内容非常的不错，但是作者的字及其丑陋，同时文章的格式乱糟糟的。我相信那依然是一篇没人喜欢看的天书。写代码也是同样的道理，即使你的代码所实现的功能非常牛逼，但我们这些凡夫俗子都看不懂，那你的代码也没有多大的价值。

我们简单看一下写出好代码要掌握哪些规范：

• 每个方法所能容纳的代码行数不要超过 30 行，一行代码的字符数量控制在 120 以内。
• 一个方法只做一件事， 就好比我们在家只吃饭，却不做饭。
• 在给类名、方法名和变量命名时尽量做到见名知意，这会比你们的注释更加给力，因为这时你们的代码自带注释功效。
• 类名的每个单词的首字母大写；方法名和变量名的第一个单词的首字母小写，后面单词的首字母大写，这就是传说中的驼峰命名法；常量名的所有字母都要大写，并且每个单词间用下划线隔开。
• 如果一个方法的形式参数中有太多的基本类型，或者数量超过了 5 个，这时你可以将这些参数封装成一个类。
• 当一个方法的逻辑比较复杂的时候，一定要加上注释；给类加上注释，以阐明一个类有哪些功能。

我们也是自己嘴中的那个傻 BI

如果你们觉得养成良好的编码习惯并不重要，或者是很难。那么你们可以时隔一个月、半年或者一年再去看你们之前写过的代码，我相信你们会喷嚏连连，因为你们会骂这是哪个傻*写的，很不幸那个傻BI就是你们自己。

不要抱着侥幸的心态，自以为只要是自己写的代码自己就能看懂。其实，你们写的代码并不是你们自己的，随着时间的推移，你们的代码就是别人的啦。为了不让别人(包括你们自己)在背后骂你们，一定要养成良好的编码习惯。

总结

我在文章中并没有详细地列举具体地编码规则，因为这些规则已经有人给出来了。阿里巴巴为我们贡献了一套 Java 开发规范，这套规范不仅适用于 Java 开发，同样对其他的编程开发有借鉴意义。这里是阿里巴巴 Java 开发手册的下载地址。[PS： 阿里巴巴的 Java 开发团队是国内最牛逼的]

最后我给大家推荐一本非常好的书[编写可读代码的艺术]，它会教你如何写出一手漂亮的代码，在书中有各种编程语言的实例。

转载于:https://my.oschina.net/u/2501837/blog/1507509