写出漂亮代码的七种方法

写出漂亮代码的七种方法

首先我想说明我本文阐述的是纯粹从美学的角度来写出代码，而非技术、逻辑等。以下为写出漂亮代码的七种方法：



1， 尽快结束 if语句



例如下面这个JavaScript语句，看起来就很恐怖：

1 function findShape(flags, point, attribute, list) {

2    if(!findShapePoints(flags, point, attribute)) {

3        if(!doFindShapePoints(flags, point, attribute)) {

4            if(!findInShape(flags, point, attribute)) {

5                if(!findFromGuide(flags,point) {

6                    if(list.count() > 0 && flags == 1) {

7                          doSomething();

8                    }

9                }

10            }

11       }

12    }   

13  }

但如果这么写就好看得多：

1 function findShape(flags, point, attribute, list) {

2    if(findShapePoints(flags, point, attribute)) {

3        return;

4    }

5 

6    if(doFindShapePoints(flags, point, attribute)) {

7        return;

8    }

9 

10    if(findInShape(flags, point, attribute)) { 

11        return;

12    }

13 

14    if(findFromGuide(flags,point) {

15        return;

16    }

17 

18    if (!(list.count() > 0 && flags == 1)) {

19        return;

20    }

21 

22    doSomething();

23 

24 }

你可能会很不喜欢第二种的表述方式，但反映出了迅速返回if值的思想，也可以理解为：避免不必要的else陈述。



2， 如果只是简单的布尔运算（逻辑运算），不要使用if语句



例如：

1 function isStringEmpty(str){

2    if(str === "") { 

3        return true;

4    }

5    else {

6        return false;

7    }

8 }

可以写为：

1 function isStringEmpty(str){

2    return (str === "");

3 }

3， 使用空白，这是免费的

例如：

1

 function getSomeAngle() {

2    // Some code here then

3    radAngle1 = Math.atan(slope(center, point1));

4    radAngle2 = Math.atan(slope(center, point2));

5    firstAngle = getStartAngle(radAngle1, point1, center);

6    secondAngle = getStartAngle(radAngle2, point2, center);

7    radAngle1 = degreesToRadians(firstAngle);

8    radAngle2 = degreesToRadians(secondAngle);

9    baseRadius = distance(point, center);

10    radius = baseRadius + (lines * y);

11    p1["x"] = roundValue(radius * Math.cos(radAngle1) + center["x"]);

12    p1["y"] = roundValue(radius * Math.sin(radAngle1) + center["y"]);

13    pt2["x"] = roundValue(radius * Math.cos(radAngle2) + center["y"]);

14    pt2["y"] = roundValue(radius * Math.sin(radAngle2) + center["y");

15    // Now some more code

16 }

很多开发者不愿意使用空白，就好像这要收费一样。我在此并非刻意地添加空白，粗鲁地打断代码的连贯性。在实际编写代码的过程中，会很容易地发现在什么地方加入空白，这不但美观而且让读者易懂，如下：

1 function getSomeAngle() {

2    // Some code here then

3    radAngle1 = Math.atan(slope(center, point1));

4    radAngle2 = Math.atan(slope(center, point2));

5 

6    firstAngle = getStartAngle(radAngle1, point1, center);

7    secondAngle = getStartAngle(radAngle2, point2, center);

8 

9    radAngle1 = degreesToRadians(firstAngle);

10    radAngle2 = degreesToRadians(secondAngle);

11 

12    baseRadius = distance(point, center);

13    radius = baseRadius + (lines * y);

14 

15    p1["x"] = roundValue(radius * Math.cos(radAngle1) + center["x"]);

16    p1["y"] = roundValue(radius * Math.sin(radAngle1) + center["y"]);

17 

18    pt2["x"] = roundValue(radius * Math.cos(radAngle2) + center["y"]);

19    pt2["y"] = roundValue(radius * Math.sin(radAngle2) + center["y");

20    // Now some more code

21 }



4， 不要使用无谓的注释

无谓的注释让人费神，这实在很讨厌。不要标出很明显的注释。在以下的例子中，每个人都知道代码表达的是“students id”，因而没必要标出。

1 function existsStudent(id, list) {

2    for(i = 0; i < list.length; i++) {

3       student = list[i];

4 

5       // Get the student's id

6       thisId = student.getId();

7 

8       if(thisId === id) {

9           return true;

10       }

11    }

12    return false;   

13 }

5， 不要在源文件中留下已经删除的代码，哪怕你标注了

如果你使用了版本控制，那么你就可以轻松地找回前一个版本的代码。如果别人大费周折地读了你的代码,却发现是要删除的代码，这实在太恨人了。

//function thisReallyHandyFunction() {

//      someMagic();

//      someMoreMagic();

//      magicNumber = evenMoreMagic();

//      return magicNumber;

//}

6，不要有太长的代码



看太长的代码实在太费劲，尤其是代码本身的功能又很小。如下：

1 public static EnumMap<Category, IntPair> getGroupCategoryDistribution(EnumMap<Category, Integer> sizes, int groups) {

2        EnumMap<Category, IntPair> categoryGroupCounts = new EnumMap<Category,IntPair>(Category.class);

3 

4        for(Category cat : Category.values()) {

5            categoryGroupCounts.put(cat, getCategoryDistribution(sizes.get(cat), groups));

6        }

#



我并不是说非要坚持70个字符以内，但是一个比较理想的长度是控制在120个字符内。如果你把代码发布在互联网上，用户读起来就很困难。

7，不要在一个功能（或者函数内）有太多代码行

我的一个老同事曾经说Visual C++很臭，因为它不允许你在一个函数内拥有超过10，000行代码。我记不清代码行数的上限，不知道他说的是否正确，但我很不赞成他的观点。如果一个函数超过了50行，看起来有多费劲你知道么，还有没完没了的if循环，而且你还的滚动鼠标前后对照这段代码。对我而言，超过35行的代码理解起来就很困难了。我的建议是超过这个数字就把一个函数代码分割成两个。

评论

31 楼 Kupid 2009-02-10  

属在

javascripteye 写道

烂代码容易写，但前提是把自己的名字属在文件头，并附上自己永不更换的手机号，好，安心写烂代码去吧

HOHO~~~这个话说的挺像我呢~~

30 楼 sslaowan 2009-01-16  

sdh5724 写道

嘿嘿， 在SVN上可写HOOK， 不符合规则的， 不让提交，哈哈

详细说说怎么搞？用CVS可以吗？

29 楼 rdsuncn 2009-01-16  

kjj 写道

好多代码都是
if(hasMony)
  maryGoToSuperMarketAndBuyToothpasteThenGoHome();

好长的函数名

28 楼 rdsuncn 2009-01-16  

优秀的代码是思维的抽象

27 楼 fan-R 2009-01-15  

总之是越改越烂

26 楼 leeldy 2009-01-14  

哇，美学系代码写法很有前途。。。

25 楼 dengge55 2009-01-14  

老话说的好，吃苦是要会吃苦的，写程序是要写简单好-骆英

24 楼 千秋霸业 2009-01-12  

同意，程序员很多时候都是在阅读别人的代码。

23 楼 打倒小日本 2009-01-12  

第一条感触很深

22 楼 Aguo 2009-01-11  

很有感触!

21 楼 javascripteye 2009-01-11  

烂代码容易写，但前提是把自己的名字属在文件头，并附上自己永不更换的手机号，好，安心写烂代码去吧

20 楼 sdh5724 2009-01-11  

嘿嘿， 在SVN上可写HOOK， 不符合规则的， 不让提交，哈哈

19 楼 lkjust08 2009-01-11  

snowolf819 写道

同意博主的想法！代码除了要完成相应的功能完，也一点要能让其他程序员很容易的看懂，而且也要有一定艺术性！！！

同意楼上的说法

18 楼 neomac.lin 2009-01-09  

看了这篇博客，再回头看看博主的其他文章。
觉得，是不是在讨论代码排版之前，先整理一下自己文章的可阅性？
分段，断句，都是提高文章可读性的基本功。
不是提意见，只是看你的文章都点累。

17 楼 chinalikelove 2009-01-09  

空白也要得太多了!
不过其它的地方是很不错的.

16 楼 syk07 2009-01-09  

还好，可以借签.

15 楼 sunfengcheng 2009-01-09  

microjuz 写道

其实个人不太喜欢3和5，至少认为lz说的太绝对。1. 有关空行，大家觉得每两行代码间必留一行空行有意义吗？在不同代码段之间留空行是有意义的，但是代码写的跟抽屉似的我觉得很难看 2. 已删除的代码保留一阵子是有必要的，特别是负责的模块比较多，或者并行开发的情况下，思路上有个承上启下的作用，我的习惯是只删除已经过了几个版本的comment段落。个人意见

第三条可以根据个人爱好！但是第五条，你既然使用了版本控制 过时的代码 就删除很干净啊！如果你每天写的代码很少可以不用删除！但是一天写几千行甚至更多！最好删除了！

14 楼 脑袋雷劈的 2009-01-09  

没有博主说的那么绝对，一切都是从实际需要出发的！

13 楼 选择了远方 2009-01-09  

学习…………

12 楼 microjuz 2009-01-09  

其实个人不太喜欢3和5，至少认为lz说的太绝对。
1. 有关空行，大家觉得每两行代码间必留一行空行有意义吗？在不同代码段之间留空行是有意义的，但是代码写的跟抽屉似的我觉得很难看
2. 已删除的代码保留一阵子是有必要的，特别是负责的模块比较多，或者并行开发的情况下，思路上有个承上启下的作用，我的习惯是只删除已经过了几个版本的comment段落。

个人意见