写出漂亮代码的七种方法

4.不要使用无谓的注释

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

function existsStudent(id, list) {
　　for(i = 0; i < list.length; i++) {
　　　 student = list[i];
　　　 // Get the student''s id
　　　 thisId = student.getId();
　　　 if(thisId === id) {
　　　　　 return true;
　　　 }
　　}
　　return false;　
}

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

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

//function thisReallyHandyFunction() {
//　　　someMagic();
//　　　someMoreMagic();
//　　　magicNumber = evenMoreMagic();
//　　　return magicNumber;
//}

6.不要有太长的代码

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

public static EnumMap getGroupCategoryDistribution(EnumMap sizes, int groups) {
　　　　EnumMap categoryGroupCounts = new EnumMap(Category.class);
　　　　for(Category cat : Category.values()) {
　　　　　　categoryGroupCounts.put(cat, getCategoryDistribution(sizes.get(cat), groups));
　　　　}

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

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

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