内部培训——规范原则与重构

前天给公司即将加入到开发团队的同事们做了一次培训，内容比较基础，但也比较使用，写出来和大家一起分享。

第一部分的内容是关于代码规范的，由于是国内开发，所以公司的核心系统的代码规范比较差，甚至于很多地方没有什么规范。这给系统的问题诊断、修改、维护以及后期的二次开发带来了很多不便，我的目的就是要把最基本的规范告诉大家，从最基本的规范做起，一点一点地提高。

之前曾经做过一次关于规范的交流，但是效果不是很好，这一次做了一些总结和提炼，想以大家更容易接受的方式来交流。

在其中我提到了以下几点：

1、距离产生美

在代码中我会采用一些形式，使得实现不同功能的代码彼此之间能够产生一些距离，这样代码看起来会比较美观，也就达到了“距离产生美”的效果。

我们可以借助以下几种方式来产生距离：

a）空格

比方说：bonus=money*rate;

可以通过空格分隔：bonus = money * rate;

b) 空行

比方说：

 

//完成第一件事的代码……//完成第二件事的代码…… 

 

两端代码之间可以放一个空行，使其中间产生距离。但是这里一个空行足矣，如果用了多个空行，那就是“距离有了，美没了”，哈哈。

c）大括号，近似于空行的效果，也就是将每个大括号都放在单独的一行上。

比方说：

try{//一些代码……}catch (Exception ex){//捕获异常的代码……} 

d）Tab符号

这个很简单，就是用来控制缩进，从而让代码显出层次来。

2、适度

这个原则也很好理解，而且针对的问题主要是不合理的变量命名以及过长的方法。

变量的长度要适度；

方法的长度要适度，一般不要超过70行；

注释的量也要适度，并非越多越好，所写的注释都应该是有用的，而不是把代码再说一遍。

3、垃圾要扔掉，有病要治好

首先垃圾指的是文件中的无用代码，比方说打出来显示的调试信息，比方说注释掉的代码等等。

病指的是文件编译之后存在的警告和错误，这在某些系统中大量存在。记得我第一次引入整个系统，编译了一次之后，竟然发现有800多个Error以及上万条的warning，我还以为自己什么地方的配置出了问题，后来发现这个系统就是在这样的一种状态下运行的，很可怕，是吧，但实际的情况就是这样。

 

掌握以上三条原则，就可以达到最基本的代码规范。虽然现在的系统使用Java开发的，但是用这种面向对象的语言开发出来的完全是面向过程的系统，所以在鬼法中没有提到与类、接口、属性等相关的内容。

 

之后我又介绍了最基本的几种坏味道以及相应的重构方法，很遗憾，大家对此不是很了解，竟然感到很稀奇，这也更让我决定要继续向大家介绍更多的常识，从而让开发更有效率，质量也更高。

 

这个部分的内容包括：（前者是坏味道，后者是重构的方法）

不规范的命名 VS 重命名

过长的方法 VS 抽取方法

重复的类方法 VS 提取父类

魔法数 VS 定义常量

 

内容很简单，在此不做过多说明。

 

其实培训这种形式为大家的交流提供了一个很好的平台，我想我们应该坚持下去，而且随着大家分享的内容不断增多，也会有越来越多的想法，这不仅仅对于团队很好，对于个人也同样是非常有益的。