代码整洁与代码质量研究.docVIP

代码整洁与代码质量研究 　　摘要：软件质量不仅依赖于架构及项目管理，而且与代码质量紧密相关。而代码质量与其整洁度成正比。将需求明确到机器可以执行的程度，就是编程要做的事，这种规约就是代码。糟糕的代码可能毁掉一家公司，混乱代码的代价是驱动生产力不断趋向零，整洁不仅与效率有关，而且关乎企业的生存。总结了如何在代码中达到clean code，即整洁和干净代码的经验规则。 　　关键词：代码整洁；代码质量；软件质量；注释；命名；类 　　中图分类号：TP306文献标识码：A文章编号文章编号2013）0010003803 　　作者简介：曹娜（1982-），女，国际商业机器科技（深圳）有限公司上海分公司助理工程师，研究方向为软件开发、Web2.0。 　　1有意义的命名 　　终端用户响应的时间中，有80%用于下载各项内容。这部分时间包括下载页面中的图像、样式表、脚本、Flash等。通过减少页面中的元素可以减少HTTP请求的次数，这是提高网页速度的关键步骤。 　　减少页面组件的方法其实就是简化页面设计。那么有没有一种方法既能保持页面内容的丰富性又能达到加快响应时间的目的呢？这里有几条减少HTTP请求次数同时又可能保持页面内容丰富的技术。 　　1.1名副其实 　　要严肃对待这个问题。在起一个表意的名字上花时间是值得的，优秀程序员从细节做起。如果名称需要注释来补充，那就不是“名副其实”。 　　反例： 　　int d；//消逝的时间，以天计算 　　范例： 　　Int elapsedTimeInDays； 　　Int daysSinceCreation； 　　Int daysSinceModificatin； 　　Int fileAgeInDays； 　　以上问题不在于代码的简洁度，而在于代码的“模糊度”。再简短的代码，如果不能表达含义，也不能做到“名副其实”。下面反例中所示的代码够简单了，但是没人知道 theList是什么东西、theList[0]的意思是什么、4是什么意义、以及返回list1该怎么用。这就是 “模糊度”，因为意义比较模糊，所以这些代码也不“名副其实”。应该根据这段代码的意图来修改这里的函数名、变量名、值（4）的含义（用常量）。 　　反例： 　　Java： pulic List getThem（）{ 　　List list1 = new ArrayList（）； 　　For（ int x： theList） 　　If（x[0]==4） 　　list1.add（x）； 　　return list1； 　　} 　　1.2命名要避免误导 　　程序员必须避免留下掩藏代码本意的错误线索。如：accountList这个名字就不太好，因为list这个词在Java中是一个类型，如果这个名字表达的类型或者含义不是list就不应该这样命名。 　　1.3做有意义的区分 　　（1）不要用数字命名，如：a1，a2，a3。某些特定的以数字命名还是可以的，比如byteArray2String。这里2同“To”。但一般在名称后接数字是不好的习惯。 　　（2）废话是另一种没有意义的区分。如：有一个类叫Product类，那么ProductInfo与ProctductData就是没有意义的区分，因为它们含义几乎一样。如果约定Product是实体类，ProductInfo是纯数据，那么还是有意义的，可以接受的。但是同时还存在ProductData就明显不好了，并且这样还是增加了一些理解成本，因为从名字上无法直接判断。nameString不比name好，原因很简单：name就其含义来说其类型一定是字符串，所以String是冗余的废话。这种程度的冗余笔者认为还是可以接受的，但是不能又出现nameStr、strName、string_name等。如果出现，说明命名规则有问题或者命名规则的执行有问题。 　　（3）使用可以读出来的名字。 　　（4）使用可以搜索出来的名字。比如数值型常量，可以起一个有意义的名字便于搜索。另外，一个好的名字往往可以更加准确地表达常量在特定场景里的含义。 　　（5） 匈牙利命名法。匈牙利命名法基本上没有必要使用，主要理由是它的长处在消减，而短处却十分明显。长处减弱：现代的编译器已经智能了，完全可以无视类型的作用。但是对于弱类型的javascript来说，还是有其必要的。理由是因为它是弱类型，而为了避免类型转换自由带来的bug，保持类型前后缀还是有其作用的，这类类型前缀除了类型语义之外还有对其用法的约束。如果是纯粹的表达类型，那么大量的前后缀毫无疑问将对阅读带来障碍。弱点：冗余。除了冗余之外，匈牙利命名法还有致命的缺点：就是变化可能使类型加入命名带来“副作用”：比如 phone