RTOS函数命名规则

时间:2022-07-23
本文章向大家介绍RTOS函数命名规则,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。


常见命名规则

  • 匈牙利命名法:广泛应用于Microsoft Windows这类环境中;
  • 驼峰命名法:近年来越来越流行。 驼峰命名法,正如它的名称所表示的那样,指的是混合使用大小写字母来构成标识符的名字。其中第一个单词首字母小写,余下的单词首字母大写。 例如: printEmployeePaychecks(); 函数名中每一个逻辑断点都有一个大写字母来标记。
  • 帕斯卡(Pascal)命名法:与驼峰命名法类似。 只不过驼峰命名法是第一个单词首字母小写,而帕斯卡命名法则是第一个单词首字母大写。因此这种命名法也有人称之为“大驼峰命名法”。 例如: DisplayInfo(); UserName 都是采用了帕斯卡命名法。在C#中,以帕斯卡命名法和骆驼命名法居多。事实上,很多程序设计者在实际命名时会将驼峰命名法和帕斯卡结合使用,例如变量名采用驼峰命名法,而函数采用帕斯卡命名法。
  • 下划线命名法: 下划线法是随着C语言的出现流行起来的,在UNIX/LIUNX这样的环境,以及GNU代码中使用非常普遍。

RTOS命名规则

变量名

  • u :代表unsigned。
  • s :代表short。
  • l : 代表long型变量。
  • c :char。 所以类似uc,us类的变量就是unsigned char,unsigned short,分别对应uint8_t,uint16_t。
  • x :为用户自定义的数据类型,比如结构体,队列等。表示类型为BaseType_t。 常看到ux开头的函数,就是unsigned且用户自定义的类型。需要注意的是size_t变量前缀也是ux。
  • e :枚举变量
  • p :指针变量 类似(uint16_t *)变量前缀为pus。
  • prv :static函数
  • v: void函数

函数名

函数名包含了函数返回值的类型、函数所在的文件名函数的功能,如果是私有的函 数则会加一个 prv(private)的前缀。

  • vTaskPrioritySet():前缀v表示返回类型为viod,Task表示在tasks.c中定义;
  • xQueueReceive():前缀x表示返回BaseType_t类型数据,Queue表示该函数在queue.c中定义;
  • pvTimerGetTimerID():前缀pv表示返回void类型指针,Timer表示该函数在timer.c.中定义;
  • prv:前缀prv表示作用范围为当前的文件;

宏定义

FreeRTOS的大多数宏都是用大写字母写的,并以小写字母作为前缀来表示 定义了宏,如下所示;

_s,_t后缀

_s:struct

_t:type