淺析FreeRTOS源代碼的編程標準與命名約定

編程標準 （Coding Standard）

FreeRTOS 源代碼遵守 MISRA (Motor Industry Software Reliability Association) 規(guī)范。

與 MISRA 標準有出入的地方如下：

? 兩個 API 函數(shù)具有兩個出口點。之所以這樣是為了效率。

? 使用標準 C 數(shù)據(jù)類型，而不是用 typedef 將其名稱重定義。

? 當建立一個任務時，代碼會直接處理堆棧的棧頂和棧底地址。由于不同的平臺的總線寬度不同，這就需要代碼中對指針變量進行算術運算。因此，對指針變量的算術運算是不可避免的。

? trace 宏定義，默認情況下被定義為空，因此不會產(chǎn)生任何代碼。

命名約定(Naming Conventions)

RTOS內核與Demo程序源代碼使用下面的約定：

變量
char類型的變量以 c 為前綴
short類型的變量以 s 為前綴
long類型的變量以 l 為前綴
float類型的變量以 f 為前綴
double類型的變量以 d 為前綴
枚舉變量以 e 為前綴
其他類型（如結構體）以 x 為前綴
指針有一個額外的前綴 p , 例如short類型的指針前綴為 ps
無符號類型的變量有一個額外的前綴 u , 例如無符號short類型的變量前綴為 us

函數(shù)
文件內部函數(shù)以prv為前綴
API函數(shù)以其返回值類型為前綴，按照前面對變量的定義
函數(shù)的名字以其所在的文件名開頭。如vTaskDelete函數(shù)在Task.c文件中定義

宏定義
宏名以所在的文件的文件名的一部分作為前綴（開頭），并且用小寫。
比如, configUSE_PREEMPTION 在文件 FreeRTOSConifg.h 中.
除了前綴，其余部分用大寫，下劃線來分隔單詞。

數(shù)據(jù)類型

基本數(shù)據(jù)類型可以直接使用，但是有如下的例外和規(guī)則：

? char類型在每個平臺都有其自身的定義方式。有些平臺 char 等價于 signed char ，另一些則等價于 unsigned char，為此，要在代碼中明確的使用 signed char 或 unsigned char 。直接使用 char類型是被禁止的。

? 不能直接使用 int 類型，要使用 short 和 long。

? float 和 double 沒有在內核中使用，但是Demo 代碼中有使用。

此外，有兩種額外的類型要為每種平臺定義。分別是：

portTickType
如果 configUSE_16_BIT_TICKS 被定義, 則 portTickType 被定義為無符號16bit 類型，否則為無符號 32 bit 類型。參考API文檔中的 定制部分獲取詳細信息。

portBASE_TYPE
被定義為當前平臺最佳的整形類型。例如，在一個 32 位的平臺上， portBASE_TYPE 被定義為32 位的數(shù)據(jù)類型。在16位的平臺上， portBASE_TYPE 則被定義為 16 位的數(shù)據(jù)類型。如果 portBASE_TYPE 被定義為 char 類型，則 必須為 signed char 類型，因為代碼中用到這種類型作為一些函數(shù)的返回值類型，而返回值必須可以為負值以用來指示錯誤條件。

編程風格
縮進
縮進使用 Tab . 一個 tab 等于 4 個空格.
注釋
注釋文字盡量不能超過 80 列，除非是用來描述一個參數(shù)。
不采用 C++ 類型的注釋（//）。