缩进样式类似于Allman(BSD),即在控制语句的下一行使用大括号,在同一级别缩进。在switch-case语句中,case与switch语句处于相同的缩进级别。
缩进使用4个空格而不是制表符。不应保留空行上的缩进。
类和结构名称以大写字母开头。它们应该是名词。例如DebugRenderer、FreeTypeLibrary、Graphics。
函数同样位于 大写开头的驼峰命名 中。例如CreateComponent、SetLinearRestThreshold。
变量位于 小写开头的驼峰命名 中。成员变量附加了下划线。例如numContacts、randomSeed_。
常量和枚举是大写的。例如Vector3::ZERO或PASS_SHADOW。
指针和引用将*或&符号附加到类型,中间没有空格。例如Drawable*drawbable、Serializer&dest。
宏NULL和0不应用于空指针,而是使用nullptr。
在可能的情况下使用override。
在类型声明中使用using而不是typedef。
在可能的情况下使用enum类。
除非枚举的值是位字段,否则对其使用单数类型名称。
对具有位字段作为值的枚举使用多个类型名称。
不要使用“Enum”、“Flags”等后缀
类定义按以下顺序进行:
公共构造函数和析构函数
公共虚拟函数
公共非虚拟成员函数
公共静态函数
公共成员变量
公共静态变量
按照受保护定义的顺序重复以上所有步骤,最后是private
头文件使用以///开头的单行注释进行注释,以将其标记为Doxygen。
内联函数尽可能在类定义中定义,而不使用内联关键字。
使用这个简短的检查表来保持贡献者和贡献者之间的代码风格一致:
首选就地成员初始化而不是初始值设定项列表。
除非索引或迭代器本身使用,否则首选基于范围的for而不是旧样式的for。
避免auto,除非它大大减少了代码大小。示例:
auto iter = variables.Find(name); // verbose iterator type: HashMap<String, Variant>::Iterator
for (auto& variable : variables) { } // verbose pair type: HashMap<String, Variant>::KeyValue