C++编码规范
- 概述
- C++中禁止不建议使用的
- 排版
- 注释
- 宏
- 变量、结构
- 函数、过程
- 源文件命名规范
概述
本文章属于我写程序时会遵循的一些规范，也有参考其它公司的一些规范，并不全面，权当成一个笔记来看吧。
C++中禁止不建议使用的
- 尽量减少使用全局变量，而是改用静态成员变量
排版
- 程序块要采用tab缩进风格编写，tab缩进的空格数为4个。
- 相对独立的程序块之间，变量说明之后必须加空行
- 示例：
// 如下不符合规范
if(!vaild_ni(ni)){
// ... program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
// 应如下书写
if(!vaild_ni(ni)){
// ... program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
- 较长的语句(>80字符）要分成多行书写长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
= SYS_get_sccp_statistic_state( stat_item );
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)
&& (n7stat_stat_item_valid (stat_item))
&& (act_task_table[taskno].result_data != 0));
- 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item))){
// ... program code
}
n7stat_str_compare((BYTE *) & stat_object,
(BYTE *) & (act_task_table[taskno].stat_object),
sizeof (_STAT_OBJECT));
- 不允许把多个短语句写在一行中，即一行只写一条语句。
// 示例：如下例子不符合规范。
rect.length = 0; rect.width = 0;
// 应如下书写
rect.length = 0;
rect.width = 0;
- 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）函数和成员函数应各独占一行并且位于同一列，同时与引用它们的语句左对齐,在函数体的开始、类的定义、结构的定义、枚举的定义的程序都要采用如上的缩进方式; if、for、do、while、switch、case语句使用另一种方式，示例如下：
void example_fun(void)
{
if(...){
... //program code
}
}
- 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。
// 逗号、分号只在后面加空格。
int a, b, c;
// 比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。
if (current_time >= MAX_TIME_VALUE)
a = b + c;
a *= 2;
a = b ^ 2;
// "!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。
*p = 'a'; // 内容操作"*"与内容之间
flag = !isEmpty; // 非操作"!"与内容之间
p = &mem; // 地址操作"&" 与内容之间
i++; // "++","--"与内容之间
// "->"、"."前后不加空格。
p->id = pid; // "->"指针前后不加空格
// if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。
if (a >= b && c > d)
注释
- 一般情况下，源程序有效注释量必须在20％以上。
- 注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
- 说明性文件（如头文件.h文件、.inc文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
- 头文件注释
/************************************************************
Copyright (C), 1994-2019, XX. XX., XXX.
FileName: test.cpp
Author:
Date:
Version: // 版本信息
Description: // 模块描述
Function List: // 主要函数及其功能
1. ...
History: // 历史修改记录
1. Date:
Author:
Modification:
2. ...
***********************************************************/
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作
// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/
- 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
- 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
- 注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。
宏
// 宏定义和枚举全部使用 **全部大写+下划线** 的书写方式
#define MY_MAX
enum MY_ENUM {
MY_ENUM1,
MY_ENUM2,
};
变量、结构
- 对于所有的变量都会使用 小写+下划线的方式去书写
- 对于特殊情况, 例如某些变量名大小写含义不同,则会使用大写的方式
| 变量类型 | 命名规范 | 命名示例 |
| 局部变量 | 小写+下划线的方式书写 | is_init |
| 成员变量 | 以m开头的 小写+下划线的方式书写 | m_member |
| 静态成员变量 | 以s开头的 小写+下划线的方式书写 | s_static_member |
| 全局变量 | 以g开头的 小写+下划线的方式书写 | g_static_member |
函数、过程
| 函数 | 命名规范 | 命名示例 |
| 全局函数 | 小写+下划线的方式书写 | void my_sum(int a, int b) |
| 成员函数名 | 采用开头单词字母大写的方式书写 | void MySum(int a, int b) |
| 类名 | 采用开头单词字母大写的方式书写 | class MySum |
源文件命名规范
源文件命名采用 单词开头字母大写的方式进行命名 **MyCommon.h** **MyCommon.cpp**
![python算法之二分查找[图]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)