`

改良程序的11技巧

 
阅读更多

1. 尽量保持方法简短

尽管很多人都遵循这个规则,但它仍然非常的重要。你写的方法要始终能在一个屏幕里放得下。如果你需要去滚动屏幕,这会分散你的注意力,而且你看不到整个的上下文。最佳长度是5-20行,这根据你的情况而定。当然,getters/setters 通常是一行代码的方法,但与其说它们是真正的方法,不如说它们只是存取工具。
2. 永远永远不要把同一个变量用于多个不同的目的

一个变量应该始终只为一个目的服务。通过使变量常量化(C++里的const, Java里的final),使得编译器能够优化编译,而且使你的代码醒目表达这个变量是不能改变的,你的程序的可读性会变得更好。
3. 使用自描述的变量名和方法名

你的代码应该,对于任何人来说,只要看一眼就能知道是干嘛的。尽量不要用简写方式,除非有特殊的习惯,就像下面的:
  src - source  pos - position  prev - previous  如果你认为描述性的名称并不是那么有价值,请对比一下n, ns, nsisd 和numTeamMembers, seatCount, numSeatsInStadium。
4. 尽可能的把变量定义在靠近使用它的地方

盖房子时,你可不希望把锤子放到别人的院子里。你希望把它们放的离手头越近越好。定义变量也是同样的道理。
int foo = 3; int bar = 5; // 一大段使用“bar”的代码, // 但没用到“foo” // ...  baz(foo);  这段代码可以简单的重构成
int bar = 5; // 一大段使用“bar”的代码, // 但没用到“foo” // ...  int foo = 3; baz(foo);  当你把变量的声明和第一次用到它的地方间隔太远时(距离超过一个屏幕),这确实会成为一个问题。记住上下文关系会变得困难,你需要滚动屏幕去找哪来的这个变量。
5. 拒绝神秘数字

当你要把什么东西跟一个常量值做比较时,记得把这个值定义成常量。没有什么会比去猜测你的同事写的这样的代码更让人头疼的事了:
il < 4384  换个形式感觉如何?
inputLength < MAX_INPUT_LENGTH  6. 友好的对待你的语言

学习新语言是一种很有乐趣的事情,你能学到一种新的完成任务的途径。当一个对一种语言已经很专业的人去学习另一种语言时,会出现一种很大的负面效应。比如说你是一个Java开发者,试图去学习Ruby。你应该学会用Ruby的方式解决问题,而不是沿用Java的解决问题的思想。
当你需要重复5遍”Hello world!“时,在Java里,你可能会这样做:
for (int i = 0; i < 5; i++) {     System.out.println("Hello world!"); }  在Ruby里,你也许会禁不住这样写:
for i in (0..5)   puts "Hello world!" end  这样看起来没问题,但有一个更好的方式:
5.times { puts "Hello world!" }  7. 不要逆常规而行

每种语言都有自己不同的习俗约定。一般来说,人们听的最多的是Java的编码规范。让我们看看其中的一些习俗规范:

 

  • 方法名应该小写字母开头,其后用字母大写的单词连接(veryLongVariableName) 
  • 类名应该都使用首字母大写的单词连接而成 
  • 常量名应该全部大写,用下划线连接(MY_CONSTANT) 
  • 左大括号应该跟 if 语句在同一行 

只有在有必要的理由时才去打破这些常规,不要轻易的因为你不高兴就违反它。如果你只是在团队里改变一些这样的习惯,那也没问题,但当把你代码拿出来和其他的没有这些思想准备的程序员共享时,问题就会来了。
8. 警惕过早优化

过早优化是所有问题的根源,至少电视上是这么说的 … 你第一应该关心的事情是写出易于理解的代码。起初写的程序不要求快。除非你的程序很慢,否则谈优化都是为时太早。如果你想优化什么东西,你首先需要知道问题出在哪。这就是我们需要profilers这个工具的原因。
在没有知道问题在哪的情况下试图对程序进行优化,其结果必然是把程序能坏,至少你的代码会丧失可读性。如果你觉得有些地方很慢,不要盲目的重写代码,你应先找到慢的证据
不要傻乎乎的去解决根本不存在的问题。
9. 积极重构测试过的程序

没有任何东西会是完美的。即使你感觉你真正写出了一段完美的代码,几个月后回头再看看,你可能会惊讶道”怎么会这样傻?“
改进程序的一个好方法就是重构,但要等程序测试通过之后。你首先要确保程序是好的可运行的,你可以通过自动化测试或手工测试完成这个工作。
之初,你需要的是程序可用。不要期望在第一次就写出完美的程序,你只需要把它写出来,可用。然后重构它,使之完美。对于你们当中知道测试驱动开发(TDD)的人来说,对这个会很熟悉。这里的关键就在于你要习惯于重构这种事情。如果你使用的是像IntelliJ IDEA这样强大的集成开发工具的话,重构的工作会变得简单的多。
重构之后,你也许会弄出一些Bug,导致某些功能出问题。这就是为什么说写自动化测试的原因。不论何时重构后,只要运行一下所有的测试用例,你就能准确的知道什么地方出了问题。
10. 不要过度沉迷于技巧

当我第一次读到有关设计模式的知识时,我觉得我找到了圣杯。这些精心设计的思想作用显著,它能使你的设计易于理解,因为你可以简单的说”我使用的是‘观察器模式’“,而不用从头到尾的解释一遍。那么,有问题吗?一切看起来都这么自然、简单,你开始不论在哪都使用设计模式。为什么不把这个类做成singleton呢?干嘛不去再创建一些工厂类呢?
于是一个80行就能写完的脚本,你最终使用了10个类,15个接口,外加一大堆范式和标记符。97%的代码不做任何事情。设计模式是一种十分有用的用来简化你的设计的工具,但这不意味着你该在所有能用到的地方都用它。你应该用它们,但不能滥用。
11. 通过习例学习新知

编程是一种学习新知的过程。当你学到了新的程序库或新语言,你可能会迫不及待的丢掉旧的代码,用你新学到的东西重新写一遍。有很多的理由都能说明你不该这么做。
往现有的应用里增加新的类库或框架同属于这种情况。就说你写了一个Javascript的web应用,期间,你发现了jQuery。现在你突然急切的想丢到你的Javascript程序,重新用jQuery写,尽管你还从来没用过它。
最好的方式是你先用jQuery写一些简单的例子,通过这种方式把你在应用里将要用到的知识都学会。需要AJAX?在你的项目之外做一些小例子,当完全弄懂了后,丢掉例子,应用到你的产品里。
如果你非常关注编程技术,我强烈的推荐你阅读Steve McConnell写的 《代码大全》 一书。它会永远的改变你对编程的认识。
  
[英文出处]:11 tips for better code

分享到:
评论

相关推荐

    如何写出漂亮的代码:改良程序的11个技巧

    如何写出漂亮的代码:改良程序的11个技巧!有很多理由都能说明为什么我们应该写出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。...

    改良程序的11技巧分享

    接下来,我们将详细探讨改良程序的11个技巧,它们能够帮助你编写出更加优质、易于维护和理解的代码。 首先,尽量保持方法简短。方法短小精悍有助于提高代码的可读性和可维护性。通常建议方法的长度能放在一个屏幕内...

    写出漂亮代码:改良程序的11个技巧

    以下是一些改良程序的技巧: 1. **尽量保持方法简短**:一个方法应该只做一件事,且尽量控制在5-20行内,避免长篇大论,以提高代码的可读性。屏幕一屏可显示完整的方法,有助于快速理解其功能。 2. **永远不要把同...

    C语言编程改良程序的11技巧

    有很多理由都能说明为什么我们应该写 出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。当你把代码拿给其他 人看时,他必须阅读你...

    如何改良你的程序代码质量的11个技巧

    如何改良你的程序代码质量的11个技巧!有很多理由都能说明为什么我们应该写出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。当你...

    微信小程序改良版青桔单车demo源码下载

    通过研究这个微信小程序改良版青桔单车的demo源码,开发者不仅可以掌握微信小程序的基本开发技巧,还能了解到共享单车类应用的实现细节,对提升小程序开发能力大有裨益。同时,这个项目也可以作为一个模板,为开发...

    CPU散热器改良技巧两则.docx

    CPU散热器改良技巧是DIY玩家提升电脑性能和稳定性的重要手段,尤其是在夏季高温环境下,良好的散热对于防止CPU过热死机至关重要。本文将探讨两个主要的改良方法:打磨散热器底座和增加散热风扇。 首先,打磨散热器...

    改良圈算法及其Matlab实现.zip

    改良圈算法是对基础圈算法的优化,可能包括了更高效的数据结构、搜索策略或者剪枝技巧,以提高算法的运行效率和解的质量。 在Matlab中实现这样的算法,我们需要考虑以下几个关键点: 1. **数据结构**:根据问题的...

    算法-计算器的改良(洛谷-P1022)(包含源程序).rar

    标题 "算法-计算器的改良(洛谷-P1022)(包含源程序).rar" 暗示了这是一个关于算法优化的问题,具体来说是针对计算器功能的改进。洛谷是一个知名的在线编程竞赛平台,P1022很可能是该平台上的一项题目编号。这个...

    基于微信小程序的围术期指导联合改良术中配合护理对膝关节镜手术患者舒适度的影响.zip

    本研究可能通过微信小程序向患者提供个性化的围术期指导,比如术前的注意事项、术中的呼吸技巧和术后的康复锻炼方法。同时,通过改良的术中配合护理,比如优化麻醉管理、改善体位摆放、减少手术中的不适感等,来...

    XListView的改良版

    通过研究这个Demo,开发者不仅可以了解如何在Android中实现下拉刷新和上拉加载,还可以学习到如何处理异步数据加载、动画效果的添加、事件监听以及如何优化滚动性能等技巧。这对于任何想要提升Android应用用户体验的...

    改良后的boxover

    这种改良后的Boxover技术可以广泛应用于各种Web应用程序,比如地图服务、数据分析图表、产品目录等,提供更直观的交互反馈和信息展示。通过自定义的Boxover,用户可以在不离开主页面的情况下获取额外信息,提高了...

    NES资料说明含程序讲义

    总之,"NES资料说明含程序讲义"是一个全面学习NES系统和嵌入式游戏开发的资源包,涵盖了硬件原理、软件编程、调试技巧等多个方面。通过深入学习,不仅可以掌握8位游戏开发的独特魅力,还能增强对嵌入式系统和底层...

    51单片机入门C语言程序

    最后,我们将学习如何使用仿真工具进行程序调试,理解单步执行、设置断点、查看变量值等调试技巧,这对于优化程序和排查错误至关重要。 总之,“51单片机入门C语言程序”这个主题涵盖了从基础理论到实践应用的全...

    java记事本程序论文.pdf

    4. **存在的不足与改良方案**:作者对设计中的不足进行了反思,可能包括性能优化、错误处理、用户体验等方面的缺陷,并提出了相应的改进策略,以提升程序的稳定性和用户体验。 论文通过实际的项目开发,深入浅出地...

    80C52 STC程序下载

    7. **调试技巧**:除了使用串口调试助手外,还可以利用单片机的内置调试功能,如断点、步进执行、查看寄存器状态等,进行更深入的程序调试。 总之,80C52 STC程序下载涉及C51编程语言、ISP技术、串口通信、专用编程...

    C语言烂漫表白程序(TCS~T)

    此外,"改良版表白程序"可能意味着原程序经过了一定程度的优化和改进,比如修复了原有的bug,提升了性能,或者增加了更多的交互元素,使得表白过程更加个性化和有趣。 这个项目的实现不仅展示了C语言的基础应用,如...

    简单的的屏幕保护程序设计报告.doc

    本次课程设计的任务是利用 VB 中所学到的编程知识和编程技巧,完成具有一定难度和工作量的程序设计题目,帮助学生掌握编程、调试的根本技能,独立完成所布置的任务。要求包括: 1. 对系统进展功能需求分析 2. 设计...

    基因工程的程序优品文档.ppt

    在这个学习过程中,学生需要掌握基因工程的操作技巧,并能设计自己的转基因生物实验。同时,通过对前沿科技和社会热点的关注,提升信息处理和批判性思维能力。然而,教学反馈显示,部分学生在基因工程基本操作程序的...

    健康体检中心体检操作程序(doc24).doc

    11. **医院(体检)感染操作规程**: - 防止院内感染是体检中心的重要职责,包括个人防护、器械消毒、医疗废物处理等。 12. **体检质量控制和改良评估标准**: - 体检中心应定期进行内部和外部质量评估,持续改进...

Global site tag (gtag.js) - Google Analytics