coding-style - 你有编码标准吗？如果是这样，它们是如何执行的？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它.

2年前关闭。




Improve this question




我参与过几个项目，我们花了很多时间讨论和编写详细的编码标准，涵盖从语法布局到实际最佳实践的所有内容。然而，我也发现这些很少被完全遵循。许多开发人员似乎在拒绝仅基于违反编码标准的代码审查方面犹豫不决。 IE。违规行为会定期提交到存储库。

我的问题是:你们有编码标准吗？他们涵盖什么？每个人都跟着他们吗？你会做什么(如果有的话)来确保每个人都遵守标准？

我知道有一个类似的问题 here ，但我关心的不是你怎么做，而是你实际上是怎么做的以及感知到的好处是什么？

Answer 1

我曾在几乎没有遵循编码实践的地方工作过，以及其他接近强制执行的地方 - 或者至少很容易检查。

几点建议:

最重要的是要接受一致性胜过您个人偏好的风格的想法。在制定之前和之后都应该讨论编码标准，但不应允许任何人选择退出。

代码审查应该是强制性的， checkin 注释包括审查者的用户名。如果您使用的是功能强大的 SCM，请考虑不允许没有有效审阅者姓名的 checkin 。

应该有一个每个人都知道的关于制定编码标准的文件。有了足够的细节，你就不应该过多地争论。

在可能的情况下，自动检查约定(通过 Lint、CheckStyle、FXCop 等)，这样提交者和审阅者都可以轻松快速检查诸如排序导入/使用指令、空格等内容。

好处是:

主要是一致性——如果你让任何人都可以在任何时候在代码库的任何部分感到“宾至如归”，它会给你更多的灵 active 。

传播最佳实践——如果你禁止公共(public)字段、可变结构等，那么没有人会意外地在你的代码中植入定时炸弹。 (至少，不是标准所涵盖的定时炸弹。当然，没有完美代码的编码标准:)

编辑:我应该指出，在大公司工作时，编码标准可能是最重要的。我相信即使在小公司中它们也会有所帮助，但在这一点上，围绕标准的流程可能不太需要。当所有开发人员彼此认识并且都在同一地点时，这会有所帮助。