关于代码整洁

标签: 代码 | 发表时间:2014-01-11 12:20 | 作者:
出处:http://www.iteye.com
  • 整洁的代码只做好一件事!每个类,每个方法都应该专注于一件事。
  • 选个好名字要花时间,但能省下更多的时间。一旦发现有更好的名称,就应该换掉旧的。
  • 如果名称需要注释来补充,那就不算是名副其实。
  • 方法名应该是动词或动词短语。
  • 每个概念对应一个词,避免在多个地方用fetch,retrieve,get等不同单词表示“获得”的意思。
  • 函数或者方法应该在做好并只做一件事的基础上尽量短小。
  • 别害怕长名称,长而具有描述性的名称,要比短而令人费解的名称好。
  • 尽量避免多参数函数或方法。
  • 可以把try/catch代码块的主体抽离出来独立成方法,使之与try/catch隔离,更清晰。
  • 避免重复代码。
  • 不要使用goto语句。
  • 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败,一旦发现自己需要写注释,应该先想想是否能用代码来表达。
  • 唯一真正准确的信息来源是代码,而不是注释。
  • 不要保留注释掉的代码。
  • 变量应该在类或这方法的顶部声明。
  • 相关方法应该按照调用顺序(或者相关性)放在一起。
  • 隐藏实现并非只是把变量通过getter和setter推向外间,而是暴露抽象接口,以便用户无需了解数据的实现就能操作数据本体。
  • 不要返回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期. 这个系列的漫画讲述程序员——这种神秘人类的囧事,故事多来源于我身边的程序员朋友,且以互联网开发背景为主.