1. 程式人生 > >FreeRTOS變數和函式命名規則

FreeRTOS變數和函式命名規則

1、變數名

        在 FreeRTOS 中,定義變數的時候往往會把變數的型別當作字首加在變數上,這樣的
好處是讓使用者一看到這個變數就知道該變數的型別。

c :  char 型變數.

s : short 型變數.

l : long型變數.

x : portBASE_TYPE型別變數,資料結構,任務控制代碼,佇列控制代碼等定義的變數名.

u : 無符號型的前面.

p : 指標變數的前面.

例:當我們定義一個無符號的 char 型變數的時候會加一個 uc 字首,當定義一個
char 型的指標變數的時候會有一個 pc 字首。

2、函式名

        函式名包含了函式返回值的型別、函式所在的檔名和函式的功能,如果是私有的函
數則會加一個 prv(private)的字首。

在函式名中加入了函式所在的檔名,這大大的幫助了使用者提高尋找函式定義的效率和了解函式作用的目的,具體的舉例如下:

1.  vTaskPrioritySet()函式的返回值為 void 型,在 task.c這個檔案中定義。
2.  xQueueReceive()函式的返回值為 portBASE_TYPE 型,在 queue.c 這個檔案中定義。
3.  vSemaphoreCreateBinary()函式的返回值為 void 型,在 semphr.h 這個檔案中定義。