我正在为一个大约15名开发人员的团队编写一份编码标准文档,每年项目负载10到15个项目.在其他部分(我可能会在这里发布)中,我正在编写一个关于代码格式的部分.首先,我认为无论出于何种原因,我们建立一些基本的,一致的代码格式化/命名标准是明智的.
我看过这个团队过去3年里写的大约10个项目,显然我发现了各种各样的风格.承包商有时进出,有时甚至是团队规模的两倍.
我正在寻找一些代码格式和命名标准的建议,这些建议确实得到了回报......但这也可以证明是合理的.我认为一致性和共享模式对于使代码更易于维护还有很长的路要走......但是,在定义标准时我还应该考虑其他事项吗？
你如何排队括号？在处理类,方法,尝试catch块,switch语句,if else块等时,是否遵循相同的括号指南？
你是否排列了列上的字段？你用下划线表示/前缀私有变量吗？您是否遵循任何命名约定,以便更容易在文件中查找详细信息？你如何订购你班级的成员？
如何建议命名空间,打包或源代码文件夹/组织标准？我倾向于从以下内容开始:
<com|org|...>.<company>.<app>.<layer>.<function>.ClassName
我很想知道是否还有其他更为公认的做法,而不是我习以为常的做法 - 在我冒昧地指示这些标准之前.已经在线发布的标准链接也很棒 - 即使我已经完成了一些.
首先找到适合您的语言的自动代码格式化程序。理由：无论文件说什么，人们都不可避免地会违反规定。通过格式化程序运行代码比在代码审查中挑剔要容易得多。
如果您使用的语言具有现有标准（例如 Java、C#），那么使用它是最简单的，或者至少从它作为初稿开始。Sun 在他们的格式化规则上投入了很多心思；你不妨利用它。
无论如何，请记住，大量研究表明，大括号位置和空格使用等不同的因素对生产力、可理解性或错误的流行率没有可测量的影响。只要有一个标准就是关键。