改良程序需要的11个技巧
导读:外刊IT评论翻译了一篇《改良程序的11技巧》,以下是全部内容:
有很多理由都能说明为什么我们应该写出清晰、可读性好的程序。最重要的一点,程序你只写一次,但以后会无数次的阅读。当你第二天回头来看你的代码时,你就要开始阅读它了。当你把代码拿给其他人看时,他必须阅读你的代码。因此,在编写时多花一点时间,你会在阅读它时节省大量的时间。
让我们看一些基本的编程技巧:
1. 尽量保持方法简短
2. 永远永远不要把同一个变量用于多个不同的目的
3. 使用自描述的变量名和方法名
4. 尽可能的把变量定义在靠近使用它的地方
5. 拒绝神秘数字
6. 友好的对待你的语言
7. 不要逆常规而行
8. 警惕过早优化
9. 积极重构测试过的程序
10. 不要过度沉迷于技巧
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?在你的项目之外做一些小例子,当完全弄懂了后,丢掉例子,应用到你的产品里。
译文链接:http://www.aqee.net/2011/01/05/11-tips-for-better-code
原文链接:http://progfu.com/best-practices/11-tips-for-better-code
转载于:{}
改良程序需要的11个技巧相关推荐
- Windows 11 小技巧- winget安装和维护应用程序
安装好Windows 11后,你可能需要为系统安装常⽤的⼯具,例如安装Visual Studio Code,Google Chrome ,VLC Player 等应⽤.以往你可能需要⾃⼰去各大网站 ...
- 25个增强iOS应用程序性能的提示和技巧 — 中级篇
本文由破船译自:raywenderlich 转载请注明出处:BeyondVincent的博客 _____________ 在开发iOS应用程序时.让程序具有良好的性能是非常关键的.这也是用户所期望的. ...
- [转]25个增强iOS应用程序性能的提示和技巧
在开发iOS应用程序时,让程序具有良好的性能是非常关键的.这也是用户所期望的,如果你的程序运行迟钝或缓慢,会招致用户的差评.然而由于iOS设备的局限性,有时候要想获得良好的性能,是很困难的.在开发过程 ...
- 师妹问我:有哪些新手程序员不知道的小技巧?
阅读本文大概需要5分钟. 一个师妹问:洋哥,我今年应届毕业,刚开始写代码,不知道有没有一些新手需要注意的地方. 给了师妹一些建议之后,感觉这是个好问题!不光是新手程序员,很多小技巧小秘密恐怕老手也未必 ...
- 微信小程序运营系列(三)——小程序八大运营功能及技巧
首先我们来做一个小小的互动,假设有一家快餐店,100多平米,店内有5个员工,地段很好,周围都是办公楼,每天中午的时候人气最旺,周围上班的人都过来吃饭,尤其是工作日11点到1点这个时间段,过了这个时间, ...
- Windows 11 小技巧- 安装
Windows 11 依赖于TPM 2.0,什么是TPM呢?TPM技术旨在提供基于硬件的与安全性相关的功能.TPM芯片是⼀个安全的加密处理器,有助于执⾏⽣成.存储和限制加密密钥的使用等操作.TPM芯片 ...
- Windows 11 小技巧- WSL运行本地GPU算力
WSL 已经被很多开发⼈员⽤于云原⽣开发,但如果你像我每天要完成⼈⼯智能应⽤的 发,会⼀直希望能加上GPU算⼒,这样就不需要再去安装⼀台Linux的机器去做⼈⼯智能的⼯作了(毕竟很多的⼈⼯智能场景都是 ...
- Windows 11 小技巧- WSL开启Linux桌面应用
WSL 经过⼏年的发展,已经是⼀个Windows下不少开发⼈员做云原⽣应⽤的必备环境,你可以在上⾯写各种语⾔,各种后端框架,也可以完成容器和k8s的部署,在Windows11下更进⼀步,直接⽀持Lin ...
- 11个技巧让你编写出更好的Python代码,值得收藏!!
在本教程中,我们将展示11个技巧来编写更好的Python代码!我们展示了许多最佳实践,它们通过使代码更加简洁和更具python风格来改进代码.以下是所有技巧的概述: 1)使用enumerate()而不 ...
最新文章
- 14Web APIs简介
- [数据结构] 时间复杂度计算
- 银盒子扫码下单在线订单开启商品售卖时段使用说明
- BigDecimal类的使用
- JavaScript(js)的replace问题的解决
- java 反射 构造方法_Java反射之构造方法反射
- iPhone 12还没出,iPhone 13开始了:将采用120Hz ProMotion显示屏
- redis的数据持久化方案
- 解决虚拟机在能ping通网关情况下出现From 192.168.1.10: icmp_seq=1 Redirect Network(New nexthop: 192.168.1.1)问题
- 点云自适应滤波matlab代码,散乱点云自适应滤波算法
- 算法学习:01背包问题求具体方案
- java读取excel模板并复制_POI复制Excel模板并填充数据
- WDR7660虚拟服务器,TP-Link TL-WDR7660路由器怎么设置?
- HZNUoj 1875 WA Jiana的游戏
- java csv oracle数据库_从文件(*.csv或*.txt)导入Oracle数据库Java源代码
- 4年级计算机 设计贺卡教案,第三课制作节日贺卡 教学设计
- 自步学习-Self-paced Learning
- w10更新以后DNS服务器未响应,图文详解win10系统dns服务器未响应的措施
- 【重识云原生】计算第2.2节——主流虚拟化技术之VMare ESXi
- 计算机中缺少mfc100.dll怎么办,缺少 mfc100u.dll,要怎么处理啊
热门文章
- 海洋zyapi.php,zyapi.php · 姬晓亮/海洋cms 海洋影视管理系统 - 免费开源PHP - Gitee.com...
- 如何将matlab转成jav,Matlab将GUI转化为exe文件,并且进行发布
- es中对标mysql group by的teams聚合类型
- 一文看尽苹果WWDC大会:今年有亮点,但都不“硬”
- 吃瓜笔记 | Momenta王晋玮:让深度学习更高效运行的两个视角
- “每天AI资讯这么多!该看哪些?”推荐一份优质资料清单
- 警惕AI军事间谍!找出导弹基地人类用2.5天,AI只要42分钟
- 史上最壕无人车买家诞生!泥潭中的Uber要搞个超大的无人出租车队
- 1.4.1bat脚本命令COPY 拷贝 复制到
- Emgu-WPF 激光雷达研究-移动物体跟踪2