当前位置：首页 > news >正文

58、【OS】【Nuttx】编码规范解读（六）

news 来源：原创 2025/5/30 15:52:52

背景

接之前 blog
53、【OS】【Nuttx】编码规范解读（一）
54、【OS】【Nuttx】编码规范解读（二）
55、【OS】【Nuttx】编码规范解读（三）
56、【OS】【Nuttx】编码规范解读（四）
57、【OS】【Nuttx】编码规范解读（五）
分析了行宽格式，注释要求，花（圆）括号风格，全局变量，结构体等，下面继续来分析上次没分析完的结构体

Nuttx 编码规范

结构体

结构体命名

在这里插入图片描述
接上篇 blog 57、【OS】【Nuttx】编码规范解读（五）

4、避免在类型定义中定义结构体，推荐将结构体定义和类型定义分开，以减少头文件之间的依赖关系，此时结构体指针可以通过前向引用的方式在头文件中声明，而不需要包含定义类型的文件
举例如下：

// module_a.h
struct module_b_struct;  // 前向声明
typedef struct module_b_struct* ModuleBHandle;	// 类型定义
void functionUsingModuleB(ModuleBHandle handle);// module_b.h
struct module_b_struct {int data;// 其他成员...
};	// 结构体定义

在这种情况下，module_a.h 不需要包含 module_b.h，只需前向声明即可，这样可以减少头文件之间的依赖关系，加快构建速度，但也会有弊端，假如结构体名字改了，要改很多头文件（霰弹式修改）

5、所有结构体名后缀以 _s 结尾

6、老生常谈的命名简洁，模块名称前缀，字母小写，减少使用下划线

结构体字段命名

在这里插入图片描述

结构体字段命名和局部变量命名规则相同
每个结构体字段（包括位字段）应在单独的一行中定义
每个结构体字段都应该有对应的注释，解释用途和含义，注释遵循之前提到过的规则
小写字母，少用下划线

举例如下
在这里插入图片描述
可以用 typedef 为结构体创建别名，但不推荐

虽然可以在另一个结构体内定义结构体，但前提是这些内部结构体必须有命名字段，但一般情况下不推荐这样做，而是将结构体定义分开，避免嵌套定义

联合体

结构体名后缀以 _u 结尾，其他规则和结构体一样

可以用 typedef 为联合体创建别名，但不推荐
在这里插入图片描述
在 Nuttx 中，通常不推荐使用单字符的变量名或字段名，但对于结构体中的联合体字段（union fields）l例外，联合体字段常用 u 作为字段名，这样可以保持字段名称简短，并防止由于联合体内成员的名字过长而使代码可读性下降
在这里插入图片描述