coding-style - 标准文件

Question

我正在为一个由大约 15 名开发人员组成的团队编写一份编码标准文档，每年的项目负载在 10 到 15 个之间。在其他部分(我可能会在这里发布)中，我正在写一个关于代码格式的部分。因此，首先，我认为无论出于何种原因，我们建立一些基本的、一致的代码格式/命名标准是明智的。

我查看了这个团队在过去 3 年中编写的大约 10 个项目，很明显，我发现了相当广泛的风格。承包商有时进进出出，有时甚至使团队规模扩大一倍。

我正在寻找一些关于代码格式和命名标准的建议，这些建议确实得到了返回……但这也确实是合理的。我认为一致性和共享模式在使代码更易于维护方面大有帮助……但是，在定义上述标准时我还应该考虑其他事情吗？

你如何排列括号？在处理类、方法、try catch block 、switch 语句、if else block 等时，您是否遵循相同的括号准则？

您是否在列上排列字段？你用下划线标注/前缀私有(private)变量吗？您是否遵循任何命名约定以更容易在文件中找到详细信息？你如何命令你的类(class)成员？

关于命名空间、打包或源代码文件夹/组织标准的建议呢？我倾向于从以下内容开始:

<com|org|...>.<company>.<app>.<layer>.<function>.ClassName

我很想知道是否还有其他比我习惯的更被接受的做法——在我冒险决定这些标准之前。与已经在线发布的标准的链接也很棒——尽管我已经做了一些。

Answer 1

首先找到一个适用于您的语言的自动代码格式化程序。原因:无论文件说什么，人们都不可避免地会违反规则。通过格式化程序运行代码比在代码审查中挑剔要容易得多。

如果您使用的是具有现有标准的语言(例如 Java、C#)，那么使用它是最容易的，或者至少从它作为初稿开始。 Sun 在他们的格式规则上花了很多心思。你不妨利用它。

无论如何，请记住，许多研究表明，大括号位置和空格使用等变化对生产力或可理解性或错误的普遍性没有可衡量的影响。只要有任何标准是关键。