C++ 代码规范

Posted 2021-06-23 izlyforever

此规范参考：Codeforces 上 Jiangly 的码风，Menci 代码规范，知乎 pansz 的回答
VSCode 的 C_Cpp: Clang_format_style 和 Clang_format_fallback style 设置为：{ BasedOnStyle: google, IndentWidth: 4,TabWidth: 4, UseTab: Always, BreakBeforeBraces: Custom, AllowShortIfStatementsOnASingleLine: true, IndentCaseLabels: false }

设置可参考：官方代码风格配置

总纲

• 不再使用 using namespace std
• 不建议使用 #include <bits/stdc++.h>
• Tab 用于缩进，空格用于对齐（可不对齐）
• 左大括号不换行（左大括号前有且仅有一个空格）
• 头文件必须全部写在开头，C 的头文件必须以 c 开头而非.h 结尾
• main 函数必须在整个程序末尾
• 常用函数尽量写成类和模板形式
• 尽量使用 STL 减少代码量
• 尽量不要用 C-type 代码
• 善用 namespace 写一些通用函数（或者类似单例的东西）。不要把 Class/Struct 和 namespace 搞混淆了。

空行

• 不能有两个连续空行
• 独立的代码块之间要有空行
• 头文件块、函数、成员函数、结构体、类，全局变量块之间必须用空行隔开

空格

空格的作用：识别族群的位置

• 前后必须都有空格：冒号、双目运算符、三目运算符
• 前加后不加：* &
• 后加前不加：关键字，逗号
• 前后都不加：. -> ::

函数和变量

• 传参时按照实际需要传 引用、const 引用、值
• 尽量不使用全局变量
• 局部变量在用时定义
• 在合适的时间使用 static 变量

命名

• 统一使用驼峰命名法
• 常量，typedef 定义的类型 全部大写
• 类私有变量以 _ 开头
• 函数和变量统一使用小驼峰
• 结构和类统一使用大驼峰
• 以 Core 结尾的核心代码是在约束条件下的高效代码，可以用 Lambda 函数写在原函数内部
• 以 S 结尾的是简单且效率较低的代码，当作对拍的测试代码

注释

• 代码尽量自注释
• 在函数最开始注释，解释输入输出变量

代码优先级

• 普通代码：正确，可行，可读，通用
• Core 代码：正确，高效，通用，可读

STL 的使用

• vector<bool> 不是 vector 类型，谨慎使用
• 尽量用 vector 取代用户输入的数组，而非开足够大的数组
• 尽量使用 emplace_back 取代 push_back，有些取代不了，就不取代了
• 多使用 pair, tuple, sort, stable_sort, iota, accumulate, for_each, lambda函数 使得代码更加优雅

代码规范的说明

空格的作用是区分，空格缩进理论上是不合理的，强烈抵制四个空格代替 Tab

双目运算符两边加空格是为了 区分运算符 和 变量，虽然 a+b（这种代码不必加空格，但是为了养成好习惯，还是加上较好），关键字后面加空格是为了避免像 函数调用

工程中不推荐使用 using namespace std ，而且不用的时候你就会知道一些陌生的函数原来是 std 中的，并且以后修改起来很麻烦。还有就是你无法保证 C++ 版本更新后的命名不会跟自己之前写的函数名重。

不建议使用万能头文件，但是本人用了是因为，打 CF 等比赛的时候你一个个的敲头文件或者写一大堆头文件，还不如就写这一个，并且以后修改成不用万能头文件也很容易

左空格不换行完全是个人喜好，换不换都可以，固定就好

其它总纲的代码规范完全是为了代码通用美感，大道至简

尽量避免全局变量是因为防止程序不可控，降低代码耦合性，局部变量用的时候定义是为了增加代码可读性，static 变量也是为了避免全局变量

驼峰命名的好处在于 “顾名思义，望文生义”（贬义褒用）
遵守代码规范，养成编程好习惯~