优秀代码的基本准则

Posted glsy

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了优秀代码的基本准则相关的知识,希望对你有一定的参考价值。

1.没有重复代码

   首先要保证没有重复代码!这就需要我们学会抽象和聚合,抽取相似部分,提高代码的可复用性。

2.功能职责单一

   功能单一是要求我们保证类、方法的功能是唯一确定的,不要在一个方法中包含多种业务逻辑,这样不利于后期维护和代码可重用。

3.命名清晰易懂

   命名是代码中无处不在的。变量、方法、类、包等这些都需要我们自定义命名。命名是为了方便我们使用,必须要做到清楚和容易理解。

4.易读注释清晰

   代码不仅是给写的人看的,同样也是给同事、同行看的,所以需要易读。易读体现在代码结构清晰,注释准确清楚,同时修改了代码逻辑,需要同步更新注释等。

5.通过测试

   代码合不合格的唯一标准是是否能通过测试,所以对应的代码必须有注释,并且必须能正确通过测试。

优秀程序员应该具有 持续改进优化 的意识。不要做写完就不管的甩手掌柜。

以上是关于优秀代码的基本准则的主要内容,如果未能解决你的问题,请参考以下文章

《代码整洁之道》精读与演绎之四 优秀代码的格式准则

进程同步机制四大基本准则

JAVA 设计模式遵循的六大基本准则

我对于前端开发的一些基本准则

(转)互利主义:道德经济人的基本行为准则

机器学习不同决策树的节点分裂准则