代码整洁之道

标签: 代码 | 发表时间:2014-07-20 10:09 | 作者:aoyouzi
出处:http://www.iteye.com

代码质量和整洁度成正比

 

有意义的命名,原则:

名副其实(用注解来补充的命名不是名副其实);

避免误导,避免使用与本意相悖的词汇;

做有意义的区分:Variable永远不要出现在变量中,Table永远不要出现在表中,废话是冗余的;

使用读得出来的名称;

使用可搜索的名称(单字母和数字常量很难搜索,exception的e也不好搜索);

单字母名称仅用于短方法的本地变量,名称长度应与其作用域大小相对应;

避免使用编码;

不必使用m_成员前缀来表明是成员变量;

接口的I前缀不如实现的imp后缀;

避免思维映射:不应当让读者把你的名称理解为他们熟知的内容;

类名和对象名应该是名词或名词短语,不应该是动词;

方法名应该是动词或动词短语;

每个概念对应一个词;

别用双关语:同一单词用于不同目的;同一术语用于不同概念;

使用解决方案领域名词;

使用领域术语;

添加有意义的语境;

 

一言以蔽之:取名最难的地方在于需要良好的描述技巧和工有的文化背景。

 

函数

第一原则是函数要短小;第二条原则还是更短小。

一个函数只做一件事,并做好这件事(判断是不是做了一件事:看能不能再拆分一个函数出来);

每个函数一个抽象级;

Switch语句:放于接口中,继承类则隐藏该部分,实现函数短小;

函数命名使用描述性的名称;

 

函数参数

最理想的是0参数,尽量少用3个参数以上的;多于的话,要考虑封装成类;

使用异常代替错误返回码;

抽离try catch块,将try中的逻辑封装成函数;

 

注释

注释存在的时间越久,就离其描述的代码越远,越累越变得全然错误,原因在于,程序员不能坚持维护注释

 

注释不能美化糟糕的代码;

唯一真正好的注释是不去写注释;

注释可以用于放大某种不合理的事物的重要性;

 

坏注释:

喃喃自语:如果决定要写注释就要写好注释;

误导性注释

错误注释

日志式注释:记录代码的修改——冗长的记录只会让模块变得凌乱不堪,删掉

 

能用函数或变量时就别用注释

 

归属和署名不必放在代码中,代码管理工具是这些信息的归属地

直接把代码注释掉是讨厌的做法

HTML注释不要存在于代码中;

非本地注释:注释内容与被注释代码脱离上下文关系;

 

短函数的函数头注释不如起个好的函数名字;

 

格式

代码格式关乎沟通,沟通是专业开发者的头等大事

 

纵向格式

尽可能用200行,不超过500行的代码文件

 

变量应该尽可能靠近其使用位置;

实体变量在类顶部声明;

相关函数:调用者放在被调用方法的上部;

概念相关:概念相关性强的代码放在一起;

 

横向格式

代码行尽量短小

方法名和左括号不必加空格,参数一一隔开;

 

 

对象和数据结构

对象把数据藏于抽象之后,暴露操作数据的函数;数据结构暴露数据;

 

对象和数据结构的二分原理:

过程式代码(使用数据结构)在于不改变既有数据结构的前提下增加新函数,面向对象的代码便于在不改变既有函数的前提下增加新类.

反之,过程式代码难以添加新的数据结构,因此必须修改所有函数.面向对象代码难以新函数,因为要修改所有类.

 

数据传送对象:DTO,只有公共变量,没有函数

 

错误处理

使用异常而非返回码

别返回null值,别传递null值

 

边界

使用第三方代码

 

类要短小:单一全责原则

内聚

 

系统

将系统的构造和使用分开

 

迭代

通过迭代设计达到整洁的目的

 

 

 



已有 0 人发表留言,猛击->> 这里<<-参与讨论


ITeye推荐



相关 [代码] 推荐:

代码重构

- - ITeye博客
随着程序的演化,我们有必要重新思考早先的决策,并重写部分代码. 代码需要演化;它不是静态的事物. 重写、重做和重新架构代码合起来,称为重构.    当你遇到绊脚石  ---  代码不在合适,你注意到有两样东西其实应该合并或是其他任何对你来说是"错误"的东西  -------- . 如果代码具备以下特征,你都应该考虑重构代码:.

代码小比较

- Tim - 斯巴达第二季
判断上百万个4k的buffer是否为全0,我最先想到的办法是:zero_buffer = malloc(4096);. /* 循环百万次读取buffer */.         /* 全0 */. 由于好奇,看看shell工具cp的代码,它的解决办法是:. /* 循环百万次读取buffer */.         /* 全0 */.

两行 JavaScript 代码

- MessyCS - Dreamer&#39;s Blog
最近看到了两行 JavaScript 代码,很受启发. 在 JavaScript 中,我们可以获取HTML元素的属性值,例如 element.id. 但是,因为 for 和 class 是 JavaScript 中的关键字,所以在 JavaScript 中这两个属性名称分别用 htmlFor 和 className 代替,于是在封装的时候需要先对这两个属性进行特殊判断.

Netty代码分析

- LightingMan - 淘宝JAVA中间件团队博客
Netty提供异步的、事件驱动的网络应用程序框架和工具,用以快速开发高性能、高可靠性的网络服务器和客户端程序[官方定义],整体来看其包含了以下内容:1.提供了丰富的协议编解码支持,2.实现自有的buffer系统,减少复制所带来的消耗,3.整套channel的实现,4.基于事件的过程流转以及完整的网络事件响应与扩展,5.丰富的example.

python代码调试

- - 阿里古古
【转自: http://blog.csdn.net/luckeryin/article/details/4477233】. 本文讨论在没有方便的IDE工具可用的情况下,使用pdb调试python程序. 例如,有模拟税收计算的程序:. debug_demo函数计算4500的入账所需的税收. 在需要插入断点的地方,加入红色部分代码:如果_DEBUG值为True,则在该处开始调试(加入_DEBUG的原因是为了方便打开/关闭调试).

ios代码开源

- - CSDN博客移动开发推荐文章
本人从10年开始搞ios开发,从菜鸟到现在的入门,期间遇到了许多困难,也总结了一些东西,本着开源精神,希望大家共同成长的目的把这个工程开源出来.. 这个工程是从11年到13年之前完成的.主要是我平时用到的一些基础功能模块.其中有其他开源的代码和我自己写的一些.代码结构基本乱,12年以后的代码结构还可以,不是很乱,之前水平有限,如果不怎么样就别喷我了.

Oracle错误代码

- - 数据库 - ITeye博客
ORA-00001: 违反唯一约束条件 (.). ORA-00017: 请求会话以设置跟踪事件. ORA-00018: 超出最大会话数. ORA-00019: 超出最大会话许可数. ORA-00020: 超出最大进程数 (). ORA-00021: 会话附属于其它某些进程;无法转换会话. ORA-00022: 无效的会话 ID;访问被拒绝.

Java代码优化

- - ImportNew
2016年3月修改,结合自己的工作和平时学习的体验重新谈一下为什么要进行代码优化. 在修改之前,我的说法是这样的:. 就像鲸鱼吃虾米一样,也许吃一个两个虾米对于鲸鱼来说作用不大,但是吃的虾米多了,鲸鱼自然饱了. 代码优化一样,也许一个两个的优化,对于提升代码的运行效率意义不大,但是只要处处都能注意代码优化,总体来说对于提升代码的运行效率就很有用了.

用 pylint, 写好代码

- Nickcheng - 赖勇浩的编程私伙局
赖勇浩(http://laiyonghao.com). Pylint 是一个 Python 代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8)和有潜在问题的代码. Pylint 是一个 Python 工具,除了平常代码分析工具的作用之外,它提供了更多的功能:如检查一行代码的长度,变量名是否符合命名标准,一个声明过的接口是否被真正实现等等.

完美的代码——Programmers(24)

- 山石 - FeedzShare
来自: 西乔的九卦 - FeedzShare  . 发布时间:2011年06月02日,  已有 2 人推荐. 慢工出细活,只要你要求快,需求分析之类的步骤都只能是过长而已. 载于《程序员》杂志2011年第4期. 这个系列的漫画讲述程序员——这种神秘人类的囧事,故事多来源于我身边的程序员朋友,且以互联网开发背景为主.