席萌0209 发表于 2018-3-20 15:38:10

安富莱C语言编码规范 5--变量、结构、常量、宏

安富莱C语言编码规范 5--变量、结构、常量、宏

1、为了方便书写及记忆,变量类型采用如下重定义:
typedef unsigned char uint8_t;

typedef unsigned short uint16_t;

typedef unsigned long int uint32_t;

typedef signed char int8_t;

typedef signed short int16_t;

typedef signed long int int32_t;

#define __IO volatile
2、常见类型的前缀
(1)对于一些常见类型的变量,应在其名字前标注表示其类型的前缀。前缀用小写字母表示。前缀的使用请参照下列表格中说明。
(2)对于几种变量类型组合,前缀可以迭加。


3、变量作用域的前缀
为了清晰的标识变量的作用域,减少发生命名冲突,应该在变量类型前缀之前再加上表示变量作用域的前缀,并在变量类型前缀和变量作用域前缀之间用下划线‘-’隔开。
具体的规则如下:
(1)对于全局变量(global variable),在其名称前加“g”和变量类型符号前缀。
uint32_t g_ulParaWord;

uint8_t g_ucByte;(2)对于静态变量(static variable),在其名称前加“s”和变量类型符号前缀。
static uint32_t s_ulParaWord;

static uint8_t s_ucByte;(3)函数内部等局部变量前不加作用域前缀。
(4)对于常量,当可能发生作用域和名字冲突问题时,以上几条规则对于常量同样适用。注意,虽然常量名的核心部分全部大写,但此时常量的前缀仍然用小写字母,以保持前缀的一致性。


4、对于结构体命名类型,表示类型的名字,所有名字以小写字母“tag”开头,之后每个英文单词的第一个字母大写(包括第一个单词的第一个字母),其他字母小写,结尾_T 标识。单词之间不使用下划线分隔,结构体变量以 t 开头。
/* 结构体命名类型名 */

typedef struct tagBillQuery_T

{

...

}BillQuery_T;

/* 结构体变量定义 */

BillQuery_T tBillQuery;

对于枚举定义全部采用大写,结尾_E 标识。

typedef enum

{

KB_F1 = 0, /* F1 键代码 */

KB_F2, /* F2 键代码 */

KB_F3 /* F3 键代码 */

}KEY_CODE_E;
5、常量、宏、模版的名字应该全部大写。如果这些名字由多个单词组成,则单词之间用下划线分隔。
宏指所有用宏形式定义的名字,包括常量类和函数类;常量也包括枚举中的常量成员。
#define LOG_BUF_SIZE 8000
6、不推荐使用位域。

weiyuliang 发表于 2018-6-14 08:59:11

学习了,谢谢,准备打印成教材,组织部门内部人员学习参考

bian 发表于 2019-1-22 17:26:21

感谢。。。。。。。。。。。。。

西点钟灵毓秀 发表于 2019-4-18 09:49:01

要是做成了pdf就哈多了:lol

eric2013 发表于 2019-4-19 17:47:51

西点钟灵毓秀 发表于 2019-4-18 09:49
要是做成了pdf就哈多了

好的,后面整个PDF版本。

wx_GKBKv9DZ 发表于 2019-8-15 15:56:00

学习了,我想把你们的规范用在我们公司上

无关风月 发表于 2019-11-4 10:37:14

为什么不推荐使用位域呀:lol

eric2013 发表于 2019-11-4 11:54:57

无关风月 发表于 2019-11-4 10:37
为什么不推荐使用位域呀

现在推荐使用了,因为M3和M4支持了硬件位带操作。

STM32H7的FMC扩展IO使用位域操作更省事,使用M3和M4内核的芯片还可以自动编译成硬件方式
http://www.armbbs.cn/forum.php?mod=viewthread&tid=94117&fromuid=58
(出处: 硬汉嵌入式论坛)

onono 发表于 2019-12-18 11:51:43

再次学习一下规范。

芯跳不止 发表于 2020-2-5 22:34:42

在次学习下安富莱编程规范

zouw96 发表于 2020-2-24 11:02:41

学习学习,现在有PDF版本了吗

eric2013 发表于 2020-2-24 11:08:33

zouw96 发表于 2020-2-24 11:02
学习学习,现在有PDF版本了吗

回头专门整理到PDF里面。

无关风月 发表于 2020-9-18 14:43:08

float类型的变量开头加f吗
double 加d吗

eric2013 发表于 2020-9-18 17:44:44

无关风月 发表于 2020-9-18 14:43
float类型的变量开头加f吗
double 加d吗

不用,不加f的话,就按双精度计算。

hjhj7591418 发表于 2023-10-25 08:06:20

硬汉大佬, 这部分有PDF文档吗??

hjhj7591418 发表于 2023-10-25 08:06:26

硬汉大佬, 这部分有PDF文档吗??

hjhj7591418 发表于 2023-10-25 08:11:42

硬汉大佬, 这部分有PDF文档吗??

hjhj7591418 发表于 2023-10-25 08:11:45

硬汉大佬, 这部分有PDF文档吗??

hjhj7591418 发表于 2023-10-25 08:11:50

硬汉大佬, 这部分有PDF文档吗??

eric2013 发表于 2023-10-25 16:04:51

hjhj7591418 发表于 2023-10-25 08:11
硬汉大佬, 这部分有PDF文档吗??

安富莱C语言规范PDF版
https://www.armbbs.cn/forum.php?mod=viewthread&tid=98500
页: [1]
查看完整版本: 安富莱C语言编码规范 5--变量、结构、常量、宏