禅道的代码包是什么名字

在代码审查中 ,开发人员需要从两个不同角度查看代码:

  1. 正确性。 该代码在逻辑上是否正确,是否按照预期的方式工作? 它会在现实世界中保持吗? 安全吗? 它可以处理错误和异常吗? 是否检查错误的输入参数和返回值? 安全吗? 在性能很重要的地方, 它是否有效 ?
  2. 可维护性。我是否能充分理解该代码以进行维护,我是否可以自己安全地对其进行更改? 它可读且一致吗? 逻辑是否太复杂,部分是否太大? 它是否经过单元测试?如果不能,则可以进行单元测试? 在这里,审阅者会发现过多的复制和粘贴 ,无论手动滚动的代码是否可以使用标准库或语言功能(遵循样式准则)来完成。

显然,在类,方法和变量中使用好名字对于使代码易于理解(如果您无法理解,就无法确定它是否正在执行应做的事情)非常重要,并且易于维护。 诸如“ 干净代码”和“代码完整 ”之类的书中都有有关正确命名的整章内容。 但是,即使是经验丰富的优秀开发人员,也很难为它们提供正确的抽象以及好的,有意义的, 意图公开的名称 。 如果他们正在编写不太了解的代码,这将尤其困难。

不良名称会导致审阅者感到困惑,或者对代码的作用做出错误的假设。 有些la脚的名字– zy懒,模棱两可的通用名无法帮助读者理解代码中正在发生的事情。 然后是一些具有误导性或完全错误的名称-曾经是正确的名称,但现在不是因为逻辑改变了而名称却没有。 您正在阅读代码,它称为postPayment ,但是postPayment不仅发布付款,而且现在执行更多操作-更糟糕的是,它不再发布任何付款。

随着时间的推移,越来越多的代码被更改,关注命名变得越来越重要。 设计不断变化,责任不断变化,而且通常是渐进的和微妙的。 添加代码,然后再删除或移动其他代码。 进行最新更改的程序员只想专注于他们在做什么,修复代码然后下车,而没有看大图,没有注意到代码的含义已更改或变得不太清楚因为他们刚刚做了。 审阅者需要密切注意这些问题。

但是命名不仅仅意味着使其他人更容易阅读和维护代码,甚至还可以使您更容易阅读和更改代码,以便稍后再使用。 正如我的一位同事指出的那样,如果某人不能为方法或类想出一个好名字,这表明他们在理解自己的工作上遇到了困难。 因此,在检查代码时,坏名不仅仅是干扰或烦恼–这是一个警告信号,表明代码中可能存在更多问题,开发人员可能对设计不够了解,无法正确进行更改,或者他们没有对他们正在做的事情给予足够的关注,并且他们可能犯了其他错误,您(审阅者)需要注意。

专注于命名有时看起来有些挑剔和挑剔,这是无休止的“风格大战”中的另一场战斗,最终因支架放置和缩进而展开的角逐。 但是,良好的命名比美学或标准化更为重要。 这是关于确保代码正确运行,并保持这种状态。

参考: 代码和代码评论:名称是什么? 来自我们的JCG合作伙伴 Jim Bird在Building Real Software博客中获得。

翻译自: https://www.javacodegeeks.com/2013/02/code-and-code-reviews-whats-in-a-name.html

禅道的代码包是什么名字