ITPub博客

首页 > 应用开发 > > 如何写出整洁的代码?没有对比就没有伤害。

如何写出整洁的代码?没有对比就没有伤害。

作者:u_151d1ef45539 时间:2019-09-29 10:16:18 0 删除 编辑

程序猿鱼先生 



写出整洁的代码,是每个程序员的追求。《clean code》指出,要想写出好的代码,首先得知道什么是肮脏代码、什么是整洁代码;然后通过大量的刻意练习,才能真正写出整洁的代码。

WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了我们是糟糕代码的受害者。国内有一个更适合的词汇:屎山,虽然不是很文雅但是更加客观,程序员既是受害者也是加害者。

对于什么是整洁的代码,书中给出了大师们的总结:

Bjarne Stroustrup:优雅且高效;直截了当;减少依赖;只做好一件事

Grady booch:简单直接

Dave thomas:可读,可维护,单元测试

Ron Jeffries:不要重复、单一职责,表达力(Expressiveness)

其中,我最喜欢的是表达力(Expressiveness)这个描述,这个词似乎道出了好代码的真谛:用简单直接的方式描绘出代码的功能,不多也不少。

本文记录阅读《clean code》之后个人“深有同感”或者“醍醐灌顶”的一些观点。

一、命名的艺术

坦白的说,命名是一件困难的事情,要想出一个恰到好处的命名需要一番功夫,尤其我们的母语还不是编程语言所通用的英语。不过这一切都是值得了,好的命名让你的代码更直观,更有表达力。

好的命名应该有下面的特征:

1.1 名副其实

好的变量名告诉你:是什么东西,为什么存在,该怎么使用

如果需要通过注释来解释变量,那么就先得不那么名副其实了。

下面是书中的一个示例代码,展示了命名对代码质量的提升

# bad code

def getItem(theList):

ret = []

for x in theList:

if x[0] == 4:

ret.append(x)

return ret

# good code

def getFlaggedCell(gameBoard):

'''扫雷游戏,flagged: 翻转'''

flaggedCells = []

for cell in gameBoard:

if cell.IsFlagged():

flaggedCells.append(cell)

return flaggedCells

来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/69927053/viewspace-3164240/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2019-07-31

  • 博文量
    155
  • 访问量
    256