首先,我是 PHP_CodeSniffer 的维护者,所以我显然对这方面有偏见。但在我作为 PHP 开发人员的 10 年中,我也研究过一些大型代码库,所以我希望我能提出一些具体的理由来说明为什么编码标准是一件好事。我可以写一个关于这个主题的博客系列,但我只会给你一个关于 PHP_CodeSniffer 是如何产生的小故事,这样你就可以理解该工具为我解决的问题。
我参与过一些大型 CMS 项目。第一个背后有一堆代码和一个相对较小的开发团队。我们没有标准。但我们没有真正的问题。这个团队很小,在一起呆了很长一段时间。我们已经习惯了。
然后我们建立了一个新的CMS。我们刚开始时只有几个开发人员。当时我是一个只有两个开发人员的团队的一员。同样,编码标准并没有给我们带来任何问题。我和其他开发人员来自相同的背景,并且已经制定了一些我们遵循的准则。那时我们不需要 PHPCS。
但该团队一次只培养了一名开发人员,最终达到了 12 名全职开发人员,其中不少人来来去去。有些来自旧的 CMS,有些来自公司外部。所有人都有不同的背景和不同的发展方法。很明显谁写了什么代码,因为风格如此不同。每当您处理复杂的事情时,您首先必须适应他们的风格,因为这不是您习惯于查看代码的方式。这就像第一次读莎士比亚。您需要先习惯它,然后才能以自然的节奏阅读。
对于开发人员来说,不得不停下来找出另一种编码风格的额外时间纯粹是浪费时间。当您陷入间距、缩进和括号位置的困境时,这是一个想法溜走的机会。归根结底,这些事情都无关紧要。但是让我告诉你,如果它们导致开发人员中断他们的流程,它们就很重要。所以我们需要一种方法来让他们不碍事,让开发人员做他们最擅长的事情。
同时,我们对 JavaScript 进行了更多的研究。一种新的语言,风格通常被抛到窗外。代码是从示例站点复制/粘贴并混合在一起的。在学习用新语言开发复杂代码时,找到一种让我们的 JS 看起来与 PHP 相似的方法是有意义的。我们可以稍后将其最小化,但我们需要能够在语言之间快速切换,再次保持我们的流畅度。
所以 PHP_CodeSniffer 就是为此而生的。它可以帮助开发人员使用相同的编码风格,使格式和其他诱饵问题完全消失。它允许您在一定程度上像对待 PHP 一样对待您的 JS。我用它来检测产品特定的气味,比如未翻译的字符串或开发人员没有使用我们正确的类包含代码。我还将它用于特定语言的气味,例如确保不会留下杀死 IE 的 JS 逗号。你可以用它来做任何你想做的事。它带有大量可以使用XML 规则集文件轻松合并在一起的嗅探器。你也可以自己写。您可以集成第三方工具,使其成为静态代码分析的一站式商店。您可以根据自己的喜好认真对待标准和代码气味。
PHP_CodeSniffer 与任何开发工具一样,应该适合您。你不为它工作。如果它产生了太多您不关心的错误,请自定义标准以删除您不想要的错误,或者将错误变成警告。但是,如果我的故事听起来像是您正在经历或将来可能会经历的事情,那么值得仔细查看 PHP_CodeSniffer 以了解它是否可以帮助您。
我希望这可以帮助您和其他人理解为什么编码标准对某些项目和开发人员非常重要。这与细节无关。这是关于从导致开发人员失去焦点的事情列表中删除编码风格。