STM32项目开发 C/C++命名规范

一、简述

  Google 的C++规范号称世界上最优秀的编码规范,于是拿来研究下,已改善自己以后的工作,今天只先学习下它的命名规范。

----------------------------------------------------------------------------------------

二、命名规则

1.文件命名规则

C语言    全部采用小写,以下划线作为间隔。比如:

cmd_save_player_info_class.cc                  my_use_full_class.cc 

C++     以类名作为文件名称。

若是类中含大量内联函数,我们还可使用-ini.h文件,使之文件内容更加清晰,于是又如:

url_table.h     url_table.cc  url-table-ini.h

文件名必须尽量简短!!!

2.类命名规则

  类型命名每个单词首字母大写,不含下划线,以名词形式。比如: MyPalyerManager,这对于所有类型命名一样,类结构体,枚举,类定义都是如此,比如:MyExcitingEnum

3.变量命名规则  

变量名采用前缀小写,首单词大写的方式,例如:

uint8_t ucTemp; uint8_t i;

uint32_t 定义的变量都加上前缀 ul。u 代表 unsigned 无符号,l 代表 long 长整型。 

uint16_t 定义的变量都加上前缀 us。u 代表 unsigned 无符号,s 代表 short 短整型。
uint8_t 定义的变量都加上前缀 uc。u 代表 unsigned 无符号,c 代表 char 字符型。

枚举变量会加上前缀 e。
指针变量会加上前缀 p,比如 uint16_t 定义的指针变量会加上前缀 pus。
根据 MISRA 代码规则,char 定义的变量只能用于 ASCII 字符,前缀使用 c。
根据 MISRA 代码规则,char *定义的指针变量只能用于 ASCII 字符串,前缀使用 pc

局部变量,不太需要严格遵守,变量前缀声明,全局变量必须严格遵守。

结构体成员变量:与普通变量相同,例如:    string name;    char ch;

类成员变量:以m_开头,例如:    m_class;

全局变量:以  g_  开头,比如:    g_system_time

函数指针变量:    pfn_开头,例如:FN_FUNC    pfn_val;

4.常量命名规则

k后面跟大写字母开头的单词,比如:

const int kDaysInAWeek=7;

const string kCompanyName="Tecent";

5.函数命名规则

C函数

每个单词首字母大写,使用命令式语气,例如:vOpenFile()、prvCheckFileName()

加上了 static 声明的函数,定义时要加上前缀 prv,这个是单词 private 的缩写。

带有返回值的函数,根据返回值的数据类型,加上相应的前缀,如果没有返回值,即 void 类型
,函数的前缀加上字母 v。

C++函数

每个单词首字母大写,使用命令式语气,例如:OpenFile()、CheckFileName()

6.名字空间命名

命名空间全小写,并基于项目名称和目录结构,比如

google_awesome_project

7.枚举、联合

全大写,下划线间隔

8.宏、枚举值

根据宏义所在的文件,文件中的宏定义声明时也将文件名加到宏定义中,比如宏定义
configUSE_PREEMPTION 是定义在文件 FreeRTOSConfig.h 里面。宏定义中的 config 就是文
件名中的 config。另外注意,前缀要小写。
除了前缀,其余部分全部大写,同时用下划线分开。

9.typedef

通用规则:每个单词首字母大写

typedef struct:以Type结尾

函数指针类型:以Pfn结尾

数组类型:Arr结尾

----------------------------------------------------------------------------------------

三、总结

  总的来说,函数名、变量名、文件名都应该具有描述性,不要随意缩写,类型变量名保持名词性描述,函数名称保持命令性语气,宏、枚举值全大写加下划线,变量、文件、命名空间、存取函数全小写加下划线,其中类成员变量还要以下划线结尾,全局变量g_开头

猜你喜欢

转载自blog.csdn.net/sadfdsfff/article/details/80456648