如何编写代码,以免同事发誓

想象一下一件事情,它将使您的代码更易于理解,并且还可以帮助您更轻松地理解他人的代码,并且可以减少“弄乱”您加入公司之前编写的他人的代码。 最好的是,您将始终了解更改它是否值得还是最好不要更改它。 赠送?!

开端太有前途了,您已经感到某种离婚。

现在,认真。

我既为自己的项目,也为一家公司编写多个代码的公司,都为自己编写代码。 我开始注意到,即使当我独自工作并返回到代码的旧部分时,也有这样的想法:“为什么我在这里这样写,那是错误的吗?” 突然之间,如果我想进行更改,那么可能会出现这样的情况:现在,出现了某些错误,并且在编写旧代码时做出的决定是最佳的。

因此,重要的是要在注释中写上“为什么”,“为什么在编程时做出这个决定?”,“为什么从所有选项中我精确地选择了停止的实现?”。 特别是如果您在团队中工作。 我遇到的情况是,另一个人编写的一段代码无法完全实现我所需要的,现在我遇到一个逻辑问题:“他为什么这样做?”,但是我们记不清所有内容,因此在逻辑上得到了答案:“我不记得为什么。 那里没有一起成长。” 而且您发现自己陷入了僵局,现在可用的选项又另一方面又害怕开始重写,因为您不知道问题的根源,也许您会遇到同事面临的相同的无法解决的问题,或者您可能不会。 现在谁知道这个? 这导致以下事实:代码的某些部分变得“无法触及”,您害怕触碰它们。

因此,我相信写出选择期权的理由会带来一定的好处。

  1. 即使是一个人工作,您也可以立即了解是否知道原因,因为编写此代码时还是很傻,或者在给定上下文的情况下这是足够的代码。
  2. 您成长为一名程序员,您可以凭经验改变过去的决策,因为您知道为什么要这样做。
  3. 随着时间的流逝,编写这样的代码的原因可能会“被遗忘”,而现在,当您看到此代码时,您就会明白,可以以安静的心态放弃它,如果不编写代码,那么它将保留在这里,怕伤到什么。
  4. 您可以以新的方式查看之前编写的旧代码。 如果以前您以傲慢的目光注视着他,现在却明白了,在程序员摆在您面前的情况下,这是一个非常正确的决定。
  5. 从清洁时的情况中节省下来,这是摆在您面前的拐杖决定,结果您打开了Pandora的盒子,因为只有这把拐杖才能防止普遍死亡。
  6. 当您写下原因时,看到此内容的另一位开发人员将能够重写,知道如何更有效地解决您所解决的问题。

最后,我想说。 该代码保留了很长一段时间,但是人们的想法和原因在特定情况下的特定时刻被迫于第二天就消失了。

Source: https://habr.com/ru/post/zh-CN459410/


All Articles