干净代码的几个特点 -Xebia

19-11-26 banq
                   

干净Clean代码特点:易于他人使用(直截了当,意图清晰,抽象性好,毫不意外,好名声)-这是最受关注的问题。

  • 它是针对现实世界制作的,即具有清晰的错误处理策略。
  • 它是最小的(做一件事,具有最小的依赖性)。
  • 擅长做什么。

清洁代码的属性

  • 没有重复
  • 做一件事
  • 有意义的名字
  • 微小的干净抽象
  • 富有表现力的
  • 单元测试
  • 显而易见-(明显的故事)
  • 简单

为什么重构和清理代码很重要?

  • 它使开发人员高效。
  • 这使添加新开发人员变得容易。
  • 易于扩展和长期维护。

作为初级开发人员,很容易争辩说,一旦代码通过了编译器,它们都是一样的。对吗?

该论点的缺陷在于它假定所有软件开发人员都在编写新代码。现实情况是,与编写新代码相比,我们花费更多的时间阅读和修改现有代码。

因此,代码的清洁度和可读性对于项目成功至关重要。编写清晰易读的代码比选择框架,测试覆盖率或项目管理解决方案更为重要。

编写干净代码的规则

命名:

  • 使用意图(目的、动机)命名
  • 变量,函数或类的名称应回答三个问题:a)为什么存在?b)它是做什么的?c)如何使用?
  • 方法名称应该有意义。通过对方法的不良命名,可能会使您的代码难以理解。
  • 方法名称应准确。

例如,一个Table类包含一个用于创建表的方法:

Table table = new Table();
table.create() 
//适当

table.createTable() /*
错误,因为table.create足以描述它正用于创建表
*/

  • 避免使用虚假信息。我们应避免使用含义与预期含义不同的词
  • 调用接口
  • 不要调用实现

函数

一个写得很好的主要函数应该读起来像个故事。就像它执行的每个方法一样,它应该做一件事,做得很好并且只能做:以正确的顺序执行正确的方法。

注释

注释似乎是使代码更具可读性的一种好方法,但是它们也很危险。为什么是这样?鲍伯叔叔最好的解释是

因为他们说谎。并非总是如此,不是故意的,而是太频繁了。注释越旧,并且与描述的代码距离越远,则很可能是纯错误。原因很简单。程序员无法现实地维护它们。”

经验法则如下:

如果注释描述了代码的用途,则它会有所帮助。如果注释描述了代码的工作方式,那么它将是有害的。

不要写描述类代表什么,解决了什么问题的注释等。不要写注释来解释代码的控制流程。解释代码“如何”工作的注释表明您的代码不干净。

如果您需要解释为什么定义了变量或for循环在做什么,请改写一个命名函数。用您的代码记录您的代码。

格式化

代码格式化是关于沟通的,沟通是专业开发人员的首要任务。

当同一项目中的不同代码块看起来不同时,会使代码阅读者怀疑这些差异是功能上的还是风格上的。这很不好,因为它增加了认知开销。

 

                   

1