cpp编码规范

一、文件与头部规范

  1. 文件头注释:每个.c源文件和.h头文件顶部必须包含标准文件头,标注文件名、核心功能描述、创建日期、作者与学号信息。
  2. 头文件包含规则
    系统库头文件在前,自定义头文件在后,两类之间用空行分隔;
    只引入代码实际用到的头文件,禁止冗余包含。

二、命名规范

  1. 变量命名
    全小写字母,多单词用下划线分隔
    命名必须见名知意,除循环计数器i/j/k外,禁止使用无意义单字母变量

三、格式与排版规范

  1. 缩进与大括号
    统一使用 4 个空格作为一级缩进,禁止混用 Tab 与空格;
    采用 Allman 大括号风格:所有函数体、控制语句(if/for/while)的大括号均单独占一行,与上级语句左对齐。
  2. 行与空格规则
    单行只写一条语句、只定义一个变量,禁止一行多语句;
    单行长度不超过 80 字符,超长表达式在运算符后换行,新行与表达式开头对齐;
    二元运算符前后各留 1 个空格;逗号、分号前无空格,后留 1 个空格;关键字后留 1 个空格再接左括号。
  3. 空行分隔
    函数之间、结构体定义之间空一行;
    函数内变量声明区与执行代码区之间空一行;
    逻辑独立的代码块之间用空行分隔。

四、注释规范

  1. 核心原则:注释解释「设计思路与原因」,而非复述「代码做了什么」;优先让代码本身自解释,杜绝冗余注释。
  2. 分级要求
    每个函数上方标注功能、参数含义、返回值含义,复杂算法补充核心思路;
    关键分支、边界处理、核心逻辑处补充说明注意事项;
    禁止对显而易见的代码加注释(例如i++; // i自增1)。

五、代码结构与语法规范

  1. 变量与函数
    变量就近声明(靠近首次使用位置),所有变量必须初始化,指针初始化为NULL;
    函数遵循单一职责原则,单个函数长度不超过 30 行,只完成一个明确功能。
  2. 控制语句
    所有if/for/while语句,哪怕执行体只有一行,也必须加大括号;
    禁止使用goto语句;循环中禁用break/continue,仅switch语句中可使用break。
  3. 作用域约束:禁止使用全局变量,数据通过参数传递,跨函数共享通过指针或返回值实现。
posted @ 2026-10-13 19:09  lelezoo  阅读(4)  评论(0)    收藏  举报