php - PHP CodeSniffer 有多大用处？代码标准执行的一般情况？

Question

就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持，但这个问题可能会引起辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the help center为指导。




8年前关闭。










锁定。这个问题及其答案是locked因为这个问题是题外话，但具有历史意义。它目前不接受新的答案或互动。








我正在尝试建立 PHP CodeSniffer 的想法在我们的持续集成服务器上，以提高我们代码库的质量。阅读文档后，我对规范化和执行我们的编码标准的想法感到非常兴奋。但是，我对我们产品的实际改进感到疑惑。我很清楚嗅探器只检测违反定义的编码标准，但是干净、一致的代码库提供什么类型的好处？用 10 万多行代码重构一个项目以符合 PEAR 标准是否值得付出额外的努力？

对于那些不熟悉 PHP CodeSniffer 或一般代码气味的人，这里是一个示例输出:

FILE: /path/to/code/myfile.php
FOUND 5 ERROR(S) AFFECTING 2 LINE(S)
--
2 | ERROR | Missing file doc comment
20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
51 | ERROR | Missing function doc comment
88 | ERROR | Line not indented correctly; expected 9 spaces but found 6

严格来说，用户/客户不会注意到重构为符合标准的产品有任何不同，但我想知道是否还有其他隐藏的好处

现在我们的代码绝不草率，我们尝试遵循我们自己的个人标准，这些标准大部分源自 Pear's Coding Standards但训练有素的眼睛可以发现差异。

所以我的问题是他们在多大程度上提高了产品的质量。它带来了什么样的潜在好处？

我是否只是对让我们的产品更接近一组标准的渴望有强制症？值得吗？如果是这样，您使用什么样的策略来实现代码嗅探器并纠正检测到的后续违规行为？

Answer 1

首先，我是 PHP_CodeSniffer 的维护者，所以我显然对这个领域有偏见。但在我作为 PHP 开发人员的 10 年里，我也研究过一些大型代码库，所以我希望我能提供一些具体的理由来说明为什么编码标准是一件好事。我可以写一个关于这个主题的博客系列，但我只会给你一个关于 PHP_CodeSniffer 如何产生的小故事，这样你就可以理解这个工具为我解决的问题。

我从事过一些大型 CMS 项目。第一个背后有一堆代码和一个相对较小的开发团队。我们没有标准。但我们没有真正的问题。团队很小，在一起呆了很长时间。我们彼此都习惯了。

然后我们建立了一个新的CMS。我们从几个开发人员开始。当时我是一个只有两个开发人员的团队的一员。同样，编码标准没有给我们带来任何问题。我和另一个开发人员来自相同的背景，并且已经制定了一些我们遵循的指导方针。那时我们不需要 PHPCS。

但是那个团队一次培养了一个开发人员，最终达到了 12 名全职开发人员，而且来来去去的人也不少。有些来自旧的 CMS，有些来自公司外部。所有人都有不同的背景和不同的发展方式。很明显谁写了什么代码，因为风格是如此不同。每当你处理一些复杂的事情时，你首先必须适应他们的风格，因为这不是你习惯看到代码的方式。这就像第一次阅读莎士比亚。您需要习惯它，然后才能以自然的速度阅读。

对于开发人员来说，不得不停下来找出另一种编码风格的额外时间纯粹是浪费时间。当您因间距、缩进和支架位置而陷入困境时，这是一个想法溜走的机会。归根结底，这些事情都无关紧要。但是让我告诉你，如果它们导致开发人员中断他们的流程，它们就很重要。所以我们需要一种方法来让他们避开障碍，让开发人员做他们最擅长的事情。

与此同时，我们更多地研究了 JavaScript。一种新语言，风格通常被抛出窗外。代码是从示例站点复制/粘贴并混合在一起的。当学习用一种新语言开发复杂的代码时，找到一种方法让我们的 JS 看起来类似于我们的 PHP 是有意义的。我们可以稍后将其最小化，但我们需要能够在语言之间快速切换，再次保持我们的流程。

所以 PHP_CodeSniffer 就是为了做到这一点而生的。它帮助开发人员使用相同的编码风格，使格式和其他诱饵问题完全摆脱困境。它允许你在某种程度上像对待 PHP 一样对待你的 JS。我使用它来检测特定于产品的气味，例如未翻译的字符串或开发人员未使用我们正确的类包含代码。我还将它用于特定于语言的气味，例如确保不会留下杀死 IE 的 JS 逗号。您可以随心所欲地使用它。它带有大量嗅探，可以使用 XML ruleset file 轻松合并在一起。 .你也可以自己写。您可以集成第 3 方工具，使其成为静态代码分析的一站式商店。您可以根据自己的喜好认真对待标准和代码异味。

PHP_CodeSniffer 与任何开发工具一样，应该适合您。你不为它工作。如果它产生太多您不关心的错误，请自定义标准以删除您不想要的错误，或者将错误转换为警告。但是，如果我的故事听起来像您正在经历或将来可能经历的事情，那么值得仔细研究 PHP_CodeSniffer，看看它是否可以帮助您。

我希望这能帮助您和其他人理解为什么编码标准对某些项目和开发人员非常重要。这不是关于细节。这是关于从导致开发人员失去焦点的事情列表中删除编码风格。