2015061504 - 代码分析之代码格式(1)

新入职的公司已经两个月,最近特意花费两天时间对代码的不足进行分析.

针对代码格式的说明.

如果说编程是书写优美的文章,那么格式就是文章的语句段落的样式,比如首行空格两个,使用排比,比喻,进行换行空格等,我们不可能一逗号到底,不可能全篇只有一个段落.如果文章段落有空格,有不空格,有的空多个,那么给阅读者的印象就是第一印象就是不协调不完整的.文章语句段落都符合绝大多数读者认可的形式.

干干净净整整齐齐的文章不管好坏,那么都会有人阅读下去的想法,勾勾抹抹段落格式不统一的文章第一眼就给人不好的心情.对于编写的代码同样如此.代码格式与功能实现与否基本没关系,如同勾勾抹抹写出来的文章内容没关系一样,但是确实文章中心的载体.饭菜都可以有很多营养,那么为什么要强调色香味俱全呢?

代码格式,就是代码的色香味,就是让代码格式一致,和具体实现的功能没多少关系.

代码格式的作用是,当前开发者和调用者阅读舒服,方便后来开发者和维护者阅读,同时会约束后来开发者的开发习惯!

代码格式主要内容:

1.属性,构造方法,成员方法在类中位置,彼此之间的相对位置.

2.缩进,空格的统一

[类,属性,构造方法,成员方法,从上而下排列]

现有代码中属性在类中位置任意位置都存在.

一般而言

1.类定义和属性之间没有换行

public classClassName {

int age;

}

2.属性和属性之间没有换行

public classClassName {

int age;

String name;

}

3.属性和方法(包括构造方法)之间有换行

public classClassName {

int age;

String name;

public ClassName(){

}

}

4.方法和方法之间有换行

public classClassName {

int age;

String name;

public ClassName(){

}

public ClassName(int age, String name){

this.age = age;

this.name = name;

}

}

公司现有代码中存在的问题是:现有代码类和属性,方法和方法,方法和属性之间有换行,没有换行并存.并没有进行统一风格.类定义,方法定义后空格,花括号的使用方式,方法内部的代码缩进,参数之间的间隔等情况都存在不一致情况.

从代码运行角度看并不是什么问题,然而从代码的可读性和给代码阅读者的感觉很糟糕!建议在开启新项目中,首先让开发成员讨论约定的编程风格,从而对代码理解,欣赏和维护上,最起码心情舒畅!感觉公司的开发人员根本就不晓得编程格式为何物

[参考代码简洁之道进行对比]