• 博客园logo
  • 会员
  • 周边
  • 新闻
  • 博问
  • 闪存
  • 赞助商
  • Chat2DB
    • 搜索
      所有博客
    • 搜索
      当前博客
  • 写随笔 我的博客 短消息 简洁模式
    用户头像
    我的博客 我的园子 账号设置 会员中心 简洁模式 ... 退出登录
    注册 登录
wyan908
博客园    首页    新随笔    联系   管理    订阅  订阅

我的c++编码规范

编码规范(代码风格规范)是一套统一的代码书写规则,主流参考标准有 Google C++ 编码规范、Java Google Style Guide、Linux 内核编码规范、PEP8(Python)等,目的是提升代码可读性、一致性、可维护性,降低多人协作、阅读、调试的成本,减少低级 bug。核心原则:代码一致优先,可读性优先。不同规范在缩进、大括号风格、命名上略有差异,但核心思想统一:命名语义化、格式统一、必要注释、拒绝魔法数。
本学期我的编码规范(C++ 为主)
一、缩进与空白格式
1.缩进:4 个空格,禁止 Tab 制表符,编辑器设置自动把 Tab 替换为 4 空格,避免不同编辑器显示错乱。
2.大括号:K&R 风格(左大括号跟在语句末尾,不单独另起一行),if/for/while/函数都统一;即使只有一行语句,强制保留花括号,防止后续增删代码引入 bug。
3.空格:if、for、while关键字后加空格;二元运算符+ - * / = > < &&两侧加空格;函数名和(之间不加空格;//注释后必须加空格;行尾禁止多余空格;连续空行最多 1 行。
单行长度:每行代码尽量不超过 80 字符,超长表达式、函数参数换行,换行运算符留在行尾。
二、 命名规范
变量、函数:小驼峰 camelCase,名称要有业务含义,拒绝无意义缩写;仅循环下标i,j,k可使用单字母变量。
类名:大驼峰 PascalCase,首字母大写
常量:全大写,下划线分隔 MAX_ARRAY_SIZE,禁止魔法数字,固定数值全部定义为常量。
文件名:英文小写,下划线分隔,.h头文件、.cpp源文件分离。
三、注释规范
文件头部:文件开头块注释,说明程序功能、作者、实验题目。
函数:每个自定义函数前写注释,说明功能、输入参数、返回值,简单工具函数可简化。
行内注释:只写为什么这么写,不要重复描述代码本身;复杂算法、边界判断处重点注释。
及时维护:修改代码后同步更新注释,不保留过期注释;使用// TODO标记待完善代码。
四、代码结构与安全规范
函数设计:单个函数功能单一,不要写超长函数;函数尽量简短,一个函数只做一件事。
变量:变量就近定义,定义时初始化,不使用未初始化局部变量。
头文件:头文件加头文件保护宏,避免重复包含;#include按系统头文件、自定义头文件分组。
代码排版:一条语句一行;不要多个变量写在同一行;尽量用括号明确运算优先级。
五、 其他约束(本学期实验作业要求)
代码编码:源文件使用 UTF-8;
提交规范:代码可直接编译运行,无多余调试输出;
一致性:同一个源文件内风格必须完全统一,不要混用多种大括号、缩进风格。
声明:部分来源于豆包ai

posted on 2026-10-11 22:45  wyan908  阅读(3)  评论(0)    收藏  举报
刷新页面返回顶部
博客园  ©  2004-2026
浙公网安备 33010602011771号 浙ICP备2021040463号-3