文档章节

#程序员自我修炼(一) - 如何编写合格代码(上)

ali安东尼
 ali安东尼
发布于 2017/07/10 14:39
字数 832
阅读 4
收藏 0
点赞 0
评论 0

在文章的开头,我先给 “合格的代码” 来做个定义:

  • 满足要求定义的初始化规则
  • 代码清晰简洁,没有思维逆反的逻辑或者刻意为之的陷阱代码
  • 尽可能控制代码风险
  • 合理的代码注释
  • 合理的标准化接口定义合,杜绝误用或者滥用

我先从一个实际例子来说起。

有人可能会问:如果一个函数的长度被标准化要求严格限制在几十行以内,还不够清晰简洁么?可读性还会差么?

我给出的答案是:会的。

function clean(tags) {
  var dedupe = {};
  for (var i=0; i<tags.length; i++){
	 tags[i] = tags[i].trim();
	 var aTag = tags[i];

		if(dedupe[aTag]){
 			 var t =tags.splice(i,1);
 			 i--;
		} else {
 			 dedupe[aTag] = true;
		}
  }
  return tags;
}

大家仔细把这代码读两遍,看看能不能推断出它想干什么?

我相信大家很难一下子明白。因为,这段代码有机个反人类的地方:

首先,在循环中改变循环相关的变量 tags,因为 tags 被改变,连带循环的终止条件也变化。因此又改变了循环的自变量 i--(这个改动肯定是调试的时候发现不对,为了解决问题加上去的)。

通过这两个反人类的处理,这个十行多一点的代码成功让自己成为其烂无比的代码。这样的代码只能通过读懂(或者测试出)其要表达的逻辑,然后重写之。

另一类的代码写的足够清晰,但是不够简洁。

const ALPHABET = ['1', '2', '3', '4', '5', '6', '7', '8', '9',
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'M', 'N', 'P', 'Q', 'R', 'S',
'T', 'U', 'V', 'W', 'X', 'Y', 'Z'];

function randomCode(length) {
  const code = [];
  for (let i = 0; i < length; i++) {
const rand = Math.floor(Math.random() * 33);
code.push(ALPHABET[rand]);
  }
  return code.join('');
}

这段代码的问题相信大家能准确理解。虽然这个代码当然是可以进一步简化的,但基本上已经无法做更多有意义的重构。 其实,我希望大家要考虑的是,我们真的有必要自己撰写这样的高重用代码么?这种基本的问题必然已有前人妥善解决,比如说:randomstring 这个模块。

const randomstring = require('randomstring');
const randomCode = length => randomstring.generate({
  length, capitalization: 'uppercase',
});

有的人可能对于“拿来主义”有所不耻,认为必须要自己逐行逐字敲的代码才靠谱。但是,我们再来看看这段问题代码,其实它还有2个隐患:

  • 设计不通用,缺乏可扩展性。

    上述的代码如果哪天要改成小写字母、或者大小写混合怎么办?每次需求变动都涉及不少改动。

  • 缺乏可靠与稳定性。

    成熟的代码是经过充分测试的,如果你硬要重写,代价不仅仅是编码实现,更加重要的是需要再经过一轮严密而繁琐的测试。

严谨的代码设计、组织和合理利用第三方开源资源库,是编写合格代码必不可少的基本功。

想要学习更多的编程技巧,请继续关注后续的连载文章。

由睿江云提供,想了解更多,请登陆www.eflycloud.com

© 著作权归作者所有

共有 人打赏支持
ali安东尼
粉丝 3
博文 192
码字总数 173101
作品 0
广州
工作日志_Index

1 程序员的自我修养 如何成为一个合格的 Java程序员 程序员如何提升自已 程序员如何学会沟通技巧 思维提升:思维广度,深度,高度,远度 大牛养成指南(1):吃的草够多,你也能成为大牛如何成为...

无寄语
2016/08/18
13
0
如何让编程产能翻二番?

软件开发过程有一个很自然的比喻:建楼房,要画图纸、搭架构、砌砖头。这个比喻大体说得过去,问题是,这个“砖头”绝非普通的砖头,具有以下特性: 一、每一块都由手工制作; 二、每一块的材...

dellfox
2014/05/08
0
0
如何从一个优秀的Java程序员变成一个高薪架构师

做了4年的java程序员,一直考虑以后的发展方向。感觉不适合走管理路线的人,所以考虑继续在技术方面深入下去。 相信好多程序员都有相同的感觉,做了好多年代码民工,感觉自己每天都在重复着相...

禁区铁铍人
2017/12/09
0
0
编程的艺术门槛

编程是门艺术,这个说法由来已久。最近在朱赟的公众号(嘀嗒嘀嗒)读到一篇文章《设计是门逻辑学,然后才是美学》,文中作者漂洋过海追寻艺术,老师却说:“设计不是艺术!”。如果设计都不是...

Fico
2016/07/11
4
0
适合程序员读的书

文章来自justjavac大大的博客:一个合格的程序员应该读过哪些书 编者按:2008年8月4日,StackOverflow 网友 Bert F 发帖提问:哪本最具影响力的书,是每个程序员都应该读的? “如果能时光倒...

modernizr
2014/04/08
1K
3
飞龙的程序员书单 – 思想、工程、架构、职业发展

思想 编程珠玑 编程珠玑,字字珠玑。这本书并不单纯讲解算法,而是由一系列实际问题切入,引导读者理解这些问题并学会解决方法,使用现有的算法,或者程序设计技巧解决问题。本书的特色是通过...

apachecn_飞龙
2016/01/16
0
0
学习前端推荐书

学习前端推荐书 作为一名前端开发人员,如果你告诉我你没有看过任何关于前端的书籍,那么我完全可以认为你不是一名合格的前端开发工程师。为什么我要以“看书”来衡量合格前端的标准?因为前...

MyDear宸
2017/05/16
0
0
关于效率、程序与生活的一些思考

前一段时间看了两本书《高效程序员的45个习惯——敏捷开发修炼之道》和《高效能程序员的修炼》。书名很相似,读完这两本书花的时间也差不多,都是两个星期左右。两本书内容差别却不小。不过,...

oschina
2014/05/10
2.6K
8
最新、程序员应该具备的12种能力!

  下面是我总结的一个合格程序员应该具备的 12种能力。中国软件行业的崛起,靠的是合格的程序员。任何华丽的管理制度都不能保证软件项目的成功交付,合格的程序员就是有力的保证,是项目成功...

科技创造
2014/10/16
0
0
10个习惯助你成为一名优秀的程序员

当谈到编程时,很多人应该都有听过10x程序员的说法。 据说一个10x程序员的效率大约是其他程序员的10倍。 这是一个有争议的话题,无论你选择相信10x程序员,还是认为这十分可笑,下面的10个习...

王练
2016/11/22
7.1K
10

没有更多内容

加载失败,请刷新页面

加载更多

下一页

shell中的函数、shell中的数组、告警系统需求分析

shell中的函数 格式: 格式: function f_name() { command } 函数必须要放在最前面 示例1(用来打印参数) 示例2(用于定义加法) 示例3(用于显示IP) shell中的数组 shell中的数组1 定义数...

Zhouliang6
14分钟前
0
0
用 Scikit-Learn 和 Pandas 学习线性回归

      对于想深入了解线性回归的童鞋,这里给出一个完整的例子,详细学完这个例子,对用scikit-learn来运行线性回归,评估模型不会有什么问题了。 1. 获取数据,定义问题     没有...

wangxuwei
35分钟前
0
0
MAC安装MAVEN

一:下载maven压缩包(Zip或tar可选),解压压缩包 二:打开终端输入:vim ~/.bash_profile(如果找不到该文件新建一个:touch ./bash_profile) 三:输入i 四:输入maven环境变量配置 MAVEN_HO...

WALK_MAN
49分钟前
0
0
33.iptables备份与恢复 firewalld的9个zone以及操作 service的操作

10.19 iptables规则备份和恢复 10.20 firewalld的9个zone 10.21 firewalld关于zone的操作 10.22 firewalld关于service的操作 10.19 iptables规则备份和恢复: ~1. 保存和备份iptables规则 ~2...

王鑫linux
今天
0
0
大数据教程(2.11):keeperalived+nginx高可用集群搭建教程

上一章节博主为大家介绍了目前大型互联网项目的系统架构体系,相信大家应该注意到其中很重要的一块知识nginx技术,在本节博主将为大家分享nginx的相关技术以及配置过程。 一、nginx相关概念 ...

em_aaron
今天
0
0
Apache Directory Studio连接Weblogic内置LDAP

OBIEE默认使用Weblogic内置LDAP管理用户及组。 要整理已存在的用户及组,此前办法是导出安全数据,文本编辑器打开认证文件,使用正则表达式获取用户及组的信息。 后来想到直接用Apache Dire...

wffger
今天
2
0
HFS

FS,它是一种上传文件的软件。 专为个人用户所设计的 HTTP 档案系统 - Http File Server,如果您觉得架设 FTP Server 太麻烦,那么这个软件可以提供您更方便的档案传输系统,下载后无须安装,...

garkey
今天
1
0
Java IO类库之BufferedInputStream

一、BufferedInputStream介绍 /** * A <code>BufferedInputStream</code> adds * functionality to another input stream-namely, * the ability to buffer the input and to * sup......

老韭菜
今天
0
0
STM 32 窗口看门狗

http://bbs.elecfans.com/jishu_805708_1_1.html https://blog.csdn.net/a1985831055/article/details/77404131...

whoisliang
昨天
0
0
Dubbo解析(六)-服务调用

当dubbo消费方和提供方都发布和引用完成后,第四步就是消费方调用提供方。 还是以dubbo的DemoService举例 -- 提供方<dubbo:application name="demo-provider"/><dubbo:registry address="z...

青离
昨天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部