C++编程规范

目录

1 基本要求

2 注释要求

3 命名要求

4 排版要求

5 版本命名

6 参考规范

---

1 基本要求

• 程序结构简单清晰，可读性强

• 函数要功能明确、高内聚

• 少用全局变量，多用局部变量

• 避免代码的二义性

2 注释要求

• 注释内容要与代码保持完全一致

• 多写注释，除非代码一目了然

• 注释位置：代码的上方或右方

• 文件开始位置必须加注释，内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明

//C语言注释模板
/****************************************************************
文件名:
Copyright (c) 2000-2024 xxx公司 
创建人:
创建日期:
文件描述：
修改历史：(修改人、修改时间、修改内容，可以在单独文档中记录)
****************************************************************/

• 函数开头必须加注释，基本内容须包括:功能、参数、返回值。其它可以包括：流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明

//C语言注释模板                               
/***************************************************************功  能:  xxx参  数:  a   -   [输入] 变量说明b   -   [输入/输出] 变量说明c   -   [输出] 变量说明返  回:  0-成功，其他-失败
**************************************************************/

3 命名要求

• 名字要容易阅读和记忆，且具有一定的实际意义

• 名字要符合“最小长度最多信息”的原则

• 变量的名字应尽量使用“名词”或“形容词+名词”

• 函数的名字应尽量使用“动词”或“动词+名词”

• 全局变量和局部变量不要同名

• 不要贪图方便而在名字中使用数字

4 排版要求

• 版面整洁、层次鲜明、对齐良好

• 程序块要采用统一的缩进风格编写

• 一行最多写一条语句，较长的语句要分成多行书

• 二元操作符前后各留一个空格

5 版本命名

推荐使用“Vx.y.z.t”的版本编号句法，如V1.0.1.20220916

• x: 主发布版本号，表示产品功能集的重要增强

• y: 特征版本号，表示产品新增了一些特征（功能集）

• z: 缺陷修复版本号，表示修复了一些缺陷

• t: 发布日期版本号，表示发布日期

6 参考规范

        华为C语言编程规范

        阿里巴巴Java开发手册