您如何记录您的编码标准？

您发现什么是发布编码标准的最佳方式？为什么？

我们使用我们的代码来记录标准.这与高级/首席工程师的执法相结合,对我们来说非常有用.我们不维护实际文档的原因是因为我们发现没有人读取它并且它变得过时了.

恕我直言,所有这一切都需要证明这一点是现有的代码,显示样式/标准.

轻装上阵!

如果您正在使用.NET进行开发.我建议使用StyleCop来检查你的构建.我还建议使用ReSharper和StyleCop插件.

使用ReSharper和StyleCop插件,您可以在违反标准的代码下获得红色"波浪形"线条,并且简单的鼠标将解释原因.没有代码评论,没有主题的文档.

在构建过程中使用StyleCop将确保所有签入的代码都符合标准.

在我看来,发布编码标准的唯一有效方法是将其集成到开发人员使用的ide中(例如eclipse或idea).因此,新代码将遵循开箱即用的标准,旧代码可以使用ide重新格式化.

只有少数开发人员会阅读编码标准,之后会有更少人使用它们......

如果您的意思是样式指南 - Word文档或PDF.国际海事组织,这是"一成不变",但在每个项目的基础上(如果你看到一些不起作用的东西,修复它为下一个项目,特别是如果它在项目的后期,你有一吨遵循现有样式的代码).

我们将它放在wiki上,其中包含指向代码片段的链接.

然后,我们在Eclipse中设置了一个代码格式化程序,以尽可能地匹配此编码标准,尽管这对最佳实践编码方法无能为力.