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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章