如何写出简洁优雅的代码

2016/09/11 Python

最近在看一个项目的代码,心里有点激动。关于如何写代码,有点想法。看到那些没有章法,随意而为的代码,浑身感到不舒服。

我想骂脏话的时候

这段时间一直在处理一个遗留的代码库,每天看着前辈们给我挖下的坑,心里想骂脏话。 简单来讲,主要有以下几个方面的问题:

  1. 很多模块的代码在 3000 行以上,有几个甚至达到 6000 行,当然和下面的问题比起来这根本不算什么问题;
  2. 很多方法代码量都在 200 行以上,有的甚至达到 500 行,很多地方写的及其累赘,比不小学生作文的水平,很多方法都是可以拆分复用的,当然和下面的问题问题比起来,这可能也不算什么问题;
  3. 极其随意的变量命名规则: 类似于a, b, cx, y, zv1, v2, v3 这些变量名随处可见,基本上这里的规则就是没有规则;
  4. 事实上和这一条比起来上面的都不是问题!没有注释,没有文档,大多数东西基本上靠猜。95% 以上的方法没有注释,将近 99% 的模型字段没有注释。

上面的这些现象会导致什么问题呢?改一个简单的问题,需要浪费大量的时间去调试相关的代码,还有可能影响正常的功能,因为代码的耦合度是在太高了。听说他们已经打算放弃这个项目,重写一套。

一群人写代码,如何让代码可控

如果不对代码做出控制,随着时间的推移,肯定会变成一个代码怪兽,没有人敢碰。

  1. 一个团队进行开发,必须要确立一套规范,大家都需要准守;
  2. 每次升级都需要 review 一下代码,这也是一个团队共同学习的机会;
  3. 文档一定要跟上,不然后期很难去维护,别人在短时间内也很难知道你具体做了什么事情。

我任务做好上面的 3 条基本上就可以写出健壮、可控的代码。

效率和质量哪个更重要

虽然愿景是好的,但是不一定做得到。这里也没有什么代码评审,现在的基本情况是只要代码可以运行,不报错就可以,基本上不要求代码的质量。

这也是我感到痛苦的原因。

Search

    Table of Contents