[FreeRTOS]命名规范

目录

为什么要学习 FreeRTOS 里面的命名规范？

数据类型命名

标准类型：

TickType_t

BaseType_t

UBaseType_t

StackType_t

TaskHandle_t

QueueHandle_t

SemaphoreHandle_t

TimerHandle_t

自定义类型：

变量的命名规则

代码示例

变量的命名公式

变量前缀总结

变量修改示例

函数的命名规则

一、函数命名通用公式

二、额外特殊规则

三、案例解析：BaseType_t xTaskCreate( ... );

四、常用返回值前缀对照表

五、典型函数举例对照

宏定义命名规则

一、宏命名公式

二、前缀对应头文件示例

本章结束

为什么要学习 FreeRTOS 里面的命名规范？

刚开始接触 FreeRTOS 源码的时候，很多人都会有一种感觉：里面的函数名字为什么这么长？比如xQueueGenericCreateStatic()、vTaskDelay()、uxTaskPriorityGet()，看起来不像自己平时写代码时那种简单明了的函数名。甚至第一次打开源码，会觉得这些命名方式增加了阅读难度。但是当真正开始学习 RTOS、阅读驱动代码，甚至接触大型工程之后，会慢慢发现，命名规范并不是为了炫技，而是为了让代码在越来越复杂的时候依然保持可读性和可维护性。

在小项目中，我们可能习惯给变量取一些简单的名字，比如data、flag、temp，几十行代码的时候没有问题，但是当一个项目发展到几万行甚至几十万行时，这种命名方式会让整个工程变得混乱。你可能几个月之后回头看自己的代码，都不知道当初定义的data到底是什么数据，flag到底表示什么状态。而优秀的工程代码会通过命名直接表达信息，比如imu_data、motor_enable_flag、depth_target，即使不用看注释，也能够大概理解变量的作用。

FreeRTOS 作为一个工业级实时操作系统，里面有大量的任务、队列、信号量、定时器等对象，如果没有严格的命名规则，代码很快就会失去可读性。例如一个函数叫Create()，你无法知道它创建的是任务、队列还是定时器，也不知道它是动态创建还是静态创建。但是 FreeRTOS 中的xQueueCreateStatic()这个名字，本身就包含了大量信息：

x表示函数有返回值，Queue表示操作对象是队列，Create表示创建，Static表示使用静态内存方式创建。一个函数名，就把它的功能、对象类型、创建方式表达出来了。再比如vTaskDelay()，看到v就知道它没有返回值，Task表示任务，Delay表示延时，所以不用查看源码也能知道这是一个任务延时函数。

这些命名习惯实际上是在减少阅读代码时的大脑负担，让程序员不需要频繁跳转到定义处查看变量含义。

学习 FreeRTOS 命名规范，更重要的意义是培养阅读大型工程代码的能力。现实的软件开发中，很少有人每天都从零开始写一个完整系统，更多时候是在阅读和维护别人已经写好的代码，比如 STM32 HAL 库、Linux 驱动、机器人控制框架、各种开源项目。这些工程通常拥有几十万行代码，如果没有良好的命名规范，程序员很难快速理解系统结构。而掌握命名规则之后，看到函数名就像阅读一种特殊语言，可以快速判断它属于哪个模块、完成什么功能、返回什么类型。

所以学习 FreeRTOS 的命名规范，并不是为了记住几个固定的前缀，而是在学习一种工程化思维。代码不仅是让计算机执行的指令，也是程序员之间交流的语言。好的命名就像一张地图，它告诉后来阅读代码的人：这里是什么模块，这个变量保存什么数据，这个函数完成什么任务。

当我们以后学习 STM32 底层驱动、机器人控制算法、Linux 系统或者更大型的软件框架时，会发现很多优秀项目都有类似的思想。现在阅读 FreeRTOS 源码，表面上是在学习几个函数和规则，实际上是在训练自己阅读工业级代码的能力。真正优秀的工程师，不一定能够背下所有 API，但他能够通过代码结构和命名快速理解一个陌生系统，这也是从“会写代码”走向“能够设计复杂系统”的重要一步。

数据类型命名

FreeRTOS 使用特定的前缀来标识数据类 型，通常以port或config开头的类型是平台相关的。

标准类型：

TickType_t

用于表示系统滴答计数（tick count）的数据类型。

核心作用：存储系统 Tick 计数（系统 Tick是周期性中断，每触发一次，计数加 1）

一般32位的单片机，TickType_t的取值为uint32_t

BaseType_t

用于表示函数返回值和布尔值（通常是 int 或 char）。

函数执行是否成功

逻辑真假

状态标志

核心作用：该架构下 “最高效的数据类型”（CPU 处理该类型时速度最快）

if(xTaskCreate(vLED1Task, "LED1",128, NULL,1,NULL)==pdPASS) { //任务创建成功 } else { //任务创建失败 }

UBaseType_t

无符号版本的 BaseType_t。

StackType_t

用于表示任务堆栈的数据类型。

TaskHandle_t

任务句柄类型。

QueueHandle_t

队列句柄类型。

SemaphoreHandle_t

信号量句柄类型。

TimerHandle_t

软件定时器句柄类型。

自定义类型：

plGlobalVar2

下面练习：左边是没修改的，右边是修改以后的

⚠️注意：int plGlobalVar2[100];数组名本身等价于首元素指针，因此数组变量使用指针前缀pl

⚠️注意：int plGlobalVar2[100];数组名本身等价于首元素指针，因此数组变量使用指针前缀pl

下面练习：左边是没修改的，右边是修改以后的

• 用户自定义类型通常以_t结尾，例如MyType_t。

  变量的命名规则

  代码示例

  void vLED1Task(void *pvParameters) { for(;;) // FreeRTOS任务无限循环，任务主体 { HAL_GPIO_WritePin(LED1_GPIO_Port, LED1_Pin, GPIO_PIN_SET); vTaskDelay(pdMS_TO_TICKS(500)); // 延时500ms HAL_GPIO_WritePin(LED1_GPIO_Port, LED1_Pin, GPIO_PIN_RESET); vTaskDelay(pdMS_TO_TICKS(500)); // 延时500ms } vTaskDelete(NULL); vTaskDelay(pdMS_TO_TICKS(100)); // 延时100ms }

  变量的命名公式

  变量名 = 类型前缀 + 实际名字

  pvParameters

  pv：类型前缀

  Parameters：变量真实名称

  前缀含义（图内示例）

  pv= pointer to void → 对应类型void *（无类型指针）

  变量前缀总结

  前缀	含义	C 类型
  v	void	void（函数普遍以 v 开头）
  pv	pointer void	void *
  uc	unsigned char	uint8_t
  c	char	int8_t
  us	unsigned short	uint16_t
  s	short	int16_t
  ul	unsigned long	uint32_t
  l	long	int32_t
  px	pointer to complex type	结构体指针（任务句柄、队列句柄等）

  变量修改示例

  int lobalVar1 = 36; // int32_t int GlobalVar2[100];

  上面的变量应变成下面

  int lGlobalVar1 = 36; // int32_t int plGlobalVar2[100];

  lGlobalVar1

• l：前缀 → long，对应 int32_t /int（32 位有符号长整型）

• GlobalVar1：语义名称，代表全局变量 1

• pl：前缀 → pointer to long，代表int32_t *（int 指针）

• GlobalVar2：语义名称

函数的命名规则

一、函数命名通用公式

函数名 = 返回值类型前缀 + 模块名 + 实际名字

二、额外特殊规则

如果函数是 static 静态函数（文件内私有函数），前缀统一使用：prv（private）

三、案例解析：BaseType_t xTaskCreate( ... );

x：返回值类型前缀，代表返回类型BaseType_t

Task：模块名，代表任务模块（对应tasks.c）

Create：函数功能名称（创建）

四、常用返回值前缀对照表

五、典型函数举例对照

• void vTaskDelay()

  v→ 返回 void；Task→ 任务模块；Delay→ 延时功能

• TaskHandle_t xTaskCreateStatic()

  x→ BaseType_t；Task模块；CreateStatic静态创建任务

• static void prvLedTask(void *pvParameters)

  prv：静态私有函数，仅当前.c 文件内可用

宏定义命名规则

一、宏命名公式

宏定义名 = 文件名前缀（小写） + 实际名字（大写，单词下划线分隔）

规则拆分：

• • 前缀：小写，代表所属头文件

  • 主体名称：全大写，多个单词使用下划线_隔开

二、前缀对应头文件示例

本章结束