我编写干净代码的4条规则

任何开发人员最宝贵的技能之一就是编写简洁的代码。 语言和框架将您置于特定的框架中,但是在编写高质量代码时,您需要自己放置框架并表现出一定的自律性。 错误的代码仍然会编译,这就是为什么某些开发人员只要能够使程序正常运行就不会过多关注。

互联网上有很多书籍和内容,您可以遵循不同的规则和做法。 只要您清楚要构建的内容,它们就很棒,但是经常会更改规范或需要更改代码库的某些部分。 这正是代码开始发臭的时候。 拼写这些类确实会让您感到沮丧,您只想让所有这些都能运行并每天调用它即可。 重构可以等待,明天就可以完成。 除非当然,除非您紧急注意一些紧急修复措施,否则您会忘记它。

在流动的条件下很难编写正确的代码,这就是为什么我创建了我在日常编码中要遵循的一组规则的原因,以减轻重构时的麻烦。

保持低缩进

您每天编写的主要代码是什么? 循环,条件语句,尝试-捕获块等。 实际上,通常必须嵌套这些变量-您有一个条件语句,以检查验证是否通过,然后您将遍历所有变量。 在其中,您还有另一个条件语句,以查看是否已达到某个变量以使其值发生变化。 这种情况经常发生,导致您的代码看起来像一棵圣诞树。

高缩进会导致混乱,开发人员一眼就无法在逻辑上分离代码。 如果您正在编写JS,更不用说块作用域变量了。 尽可能减少缩进,将逻辑分离为其他方法,并在可能时进行重组。 这是我喜欢在日常编码中使用的东西。 而不是像这样编写验证(后面是伪代码):

if (validation.isSuccessful()) { // do sth. } else { // do sth. else // do sth. else }

我这样做:

if (validation.fails()) { // do sth. return response } // do sth. else; if it reaches here, validation was successful // do sth. else; if it reaches here, validation was successful

订购您的代码

我不必告诉您水平和垂直代码结构的重要性。 我从来不会在逻辑上分开的代码中留下多于一个的空行。 如果您必须澄清一些内容,请使用注释,但是将2–3个空白行卡在中间以分隔逻辑肯定会要求为此使用另一种方法。 代码变得更难阅读,并跟踪您正在查看的内容。

至于水平结构,请避免使用过长的线,但同时不要将所有内容折叠到比应有的空间小的位置。 不要保留这些多余的字节,并在其他运算符之前留一个空格。

管理方法长度

我已经阅读了很多关于方法应该使用多长时间以及何时拆分它们的知识。 许多人说,一种方法应该足够简短,以使其能够适合屏幕而无需滚动。 我遵循的规则是,一种方法应该做一件事情—顾名思义就是这样做。 是的,只要方法将某些内容存储到数据库中,它的时间可能会更长。 您需要验证输入,准备查询,执行它们并处理错误。 保留方法中最具体的部分本身,并抽象所有其他内容。 这使您可以使方法更短并重用通用功能。 如果您设法保持类的流动性,则可获得加分,因此您在方法之间的跳转不会过多

不要留下无效的代码

您已经浏览了多少遍别人的代码,并且看到过注释块。 只是站在那儿,保持空间。 你删除了吗? 毕竟您可能不知道为什么他们在那里。 您不知道它们是否被暂时注释掉了,因为它们没有被删除,因此您最好不要触摸它。

每当您注释掉代码以便以后删除时,请立即执行。 在99%的时间中,您不再需要该代码,不必担心。 即使您这样做,我们也拥有复杂的版本控制系统,如果您决定再次使用它,它将负责确保旧源代码的安全。

感谢您的阅读,我在这里结束我的咆哮。 如果您想阅读我对编码的更多想法,请查看我的其他文章。

From: https://hackernoon.com/my-4-rules-for-writing-clean-code-eb19ab2f25ac

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值