我的c++编码规范(1)
一. 格式与缩进
1.缩进统一使用4 个空格,禁止 Tab,避免不同编辑器显示错乱
2.大括号采用 Allman 风格:if、for、while、函数的左大括号单独换行,右大括号也单独一行
3.运算符+ - * / = > < && ||前后添加空格;逗号后面加空格
4.单行代码长度尽量控制在 80 字符以内,过长语句换行
5.逻辑块之间增加空行分隔,区分变量定义、循环、函数等模块。
示例:
bool BinarySearch(vector nums, int target)
{
int left = 0;
int right = nums.size() - 1;
while (left <= right)
{
int mid = left + (right - left) / 2;
if (nums[mid] == target)
{
return true;
}
else if (nums[mid] < target)
{
left = mid + 1;
}
else
{
right = mid - 1;
}
}
return false;
}
二. 命名规范
1.普通变量、函数参数:snake_case下划线命名,小写英文;循环下标允许i,j,k
2.函数名:动词开头,描述功能,binary_search
3.常量:全大写+下划线 MAX_SIZE,消除魔法数字
4.结构体/类名:大驼峰 TreeNode
5.原则:变量作用域越大,名字越详细;局部临时变量可以简短。
三、注释规范:不注释代码做了什么,注释代码为什么这么写
1.文件头部简短注释:程序名称、功能、作者
2.每个自定义函数头部写单行/简短块注释:函数功能、参数含义、返回值
3.普通顺序代码不需要重复注释;边界判断、特殊处理必须加注释
4.不保留大段被注释掉的废弃代码,直接删除
5.注释符号//后面保留一个空格。
// 二分查找,在有序数组nums中查找target
// 返回true表示找到,false未找到
bool binary_search(vector nums, int target)
四、代码结构与设计规范
- 单一职责原则:一个函数只做一件事。输入输出放 main,算法逻辑封装到独立函数
- 尽量减少全局变量,优先局部变量、函数传参;必须使用全局变量时,命名明显区分
- 尽量使用const修饰不可修改变量,保护数据
- 头文件按需引入,不#include多余库
- 提前考虑边界用例:空输入、极值、数组边界,防止越界、溢出
- 优先可读性,学生作业清晰优先。
五. 代码提交与清理规范 - 提交前删除调试用的多余cout打印
- 去掉无用变量、未使用函数
- 统一检查格式、命名、注释,保证同一份代码风格统一。

浙公网安备 33010602011771号