约定

公共风格指南包括两层含义,一是各类编程语言,都建议遵守的公共风格,另一层含义指的是代码提交流程。

语言风格

比如类命名、函数命名、变量命名、文件命名、缩进、换行、函数长度等等。 公共风格适合大多数语言使用,但也存在个例。 比如,C++和php等语言可以使用4个字符长度的tab作为统一缩进格式,但python则需要空格缩进; 再比如大多数语言都可以使用花括号{}来放置函数语句,但python这类不使用花括号的语言就无法遵守花括号相关的代码风格。 虽然存在着各种各样的例外,但我们不必教条主义,根据具体情况灵活判读即可。 正如本系列文档其他章节内容,对于大多数读者来说仅仅是一种编程风格建议。 当然,对本项目的成员来说,本风格指南不仅仅是风格建议,更是规范要求。

代码提交流程

代码提交前: (1)检查是否存在调试过程代码或冗余代码,有则删除; (2)检查编译打包等操作是否正常,禁止提交存在如编译打包之类明显问题的代码; (3)功能自测,禁止提交自测未通过的代码; 代码提交时: (4)提交记录需清晰明确说明当前提交修改内容,禁止提交类似update、1 等无意义标识; (5)应尽量清晰描述当前更改造成的改变,比如具体哪一部分的代码做了怎样的功能升级、bug修复或者接口更新等操作。 代码提交后: (6)触发冒烟测试,保证当前版本能通过自动化用例测试; (7)向项目干系人周知版本更新内容,推进上下游对接模块核查相关工作

注意: 本系列文档在最初编制的时候,由于在作者过去的职业生涯中C++开发经验相比重较大,所以公共风格里很多内容都是《Google C++ code style guide》中的内容。 本次修订处于进度考虑,这些内容并没有移除或者搬迁至C++模块中。这种情况作者会做引申解释,如有不妥当的地方欢迎读者朋友指出。