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