加入我们项目的新程序员经常会问我们是否具有自动格式化工具,以使Java代码看起来完全符合Qulice的期望。 (Quili是我们使用的静态分析器。)我总是回答说,拥有这样一个自动代码抛光器只会有害,不会帮助项目及其成员改进和成长。 这就是为什么我这么认为。
静态分析是我们与只读master分支结合使用的方式,它是对请求请求的完全自动化的不妥协的检查,主要用于发现代码格式错误。 假设我们希望整个存储库中的Java代码如下所示:
final class Doc {private final File file;public void remove() {if (this.file.exists()) {this.file.delete();}}
}
但是,您将其重构为更大的任务的一部分,并提交如下的拉取请求:
class Doc {private File f;public void remove(){if (f.exists())f.delete();}
}
对于你们中的某些人来说,这似乎没有太大的区别,因为两个代码段都可以毫无问题地编译,并且工作方式完全相同。 但是,对于我们(存储库维护者)而言,这很重要。 我们确实希望我们的类始终是final
,我们确实希望它们是不可变的(因此所有属性也应该是final
),我们想为此添加所有属性引用前缀this.
,并且我们希望代码采用相同的格式,因为我们认为代码的统一性会大大提高其可维护性。
当然,我们可以创建一个工具,然后您可以使用该工具重新设置代码的格式,使其看起来像我们想要的样子。 但是在那种情况下,您将永远无法了解项目想要您做什么以及为什么要这么做 。
您将不知道我们规则背后的原因。 您永远不会考虑它们。 您将不会真正在乎它们。 但是,它们不仅涉及空格和方括号的格式。 Qulice中有900多个 ,其中一些是专门针对我们正在讲授的面向对象的哲学而设计的。
因此,简而言之,我们不希望您轻松进行静态分析阶段。 我们希望您为了学习而受苦。
翻译自: https://www.javacodegeeks.com/2018/01/educational-aspect-static-analysis.html