不定期有讀者在問：

怎么才能寫出漂亮的代碼？

哪里有優秀的代碼可以參考？

怎樣才能提高自己編碼水平？

其實，我們身邊到處都有優秀的代碼可以借鑒，只是你沒有認真去發現而已。裸機、RTOS、Linux等各類優秀的開源代碼相信你一定見到過，還有一些優秀的開源庫你也肯定接觸過。

想要寫出漂亮、優秀的代碼，首先，你的代碼必須要有一套規范。

今天就給大家分享一下我們身邊熟知的RTOS的編碼規范，以目前（2023-01-10）最新版本的uC/OS-III V3.08.02和 FreeRTOS V10.5.1為例：

編碼標準

uC/OS 和FreeRTOS 都是遵循 MISRA C 編碼標準，均支持 PC-Lint 靜態檢查，兩者官方文檔都有說明。

提示：

MISRA C 標準，指的是汽車 C 語言開發標準，可以參看之前分享的文章：MISRA C：2012 標準是什么？

1.uC/OS

uC/OS文章明確指出遵循MISRA C:2012標準，也支持PC-Lint 的靜態檢查。

2.FreeRTOS

FreeRTOS也明確指出采用 MISRA C編碼標準，但是不支持 C99 之后的標準，也支持 PC-Lint 靜態檢查。

FreeRTOS在源代碼中有大量說明（注釋）對PC-Lint靜態檢查可能會引起異常的代碼，這一點在 uC/OS 源代碼中是沒有的。

比如：

配置文件

兩種RTOS配置文件（也就是所謂的“裁剪”文件）的“內容”有點類似，也是進行了分類。

不過，uC/OS的分類和注釋更人性化，更適合初學者理解。

1.uC/OS

uC/OS的配置文件通常是：os_cfg.h

2.FreeRTOS

FreeRTOS的配置文件通常是：FreeRTOSConfig.h

標頭

兩種RTOS標頭的“內容”有點類似，只是一個居中，一個靠左。

1.uC/OS

包含RTOS版本、版權說明、開源協議說明等：

2.FreeRTOS

包含RTOS版本、版權說明、開源協議說明、網址等，和uC/OS類似。

命名

兩種RTOS命名規則差別有點大，但都符合常規代碼命名規則。

1.文件名

uC/OS以【os_系統文件】方式，顯得更規范（體現了模塊化）。

FreeRTOS就比較直接，這個可能是剛才是命名的時候沒有長期規劃，然后為了兼容，一直沿用至今。（這種更容易引起文件重名）

2.宏

兩者有共同之處：下劃線隔開大寫字母，但是開頭（前綴）有一定區別。

以“配置文件”為例：uC/OS以【OS_CFG_】開頭，FreeRTOS以【config】開頭。

3.數據類型

uC/OS定義的數據類型，相對更常見，也更適合新手。

FreeRTOS定義的數據類型，更“系統”一點，適合老司機，對新手相對沒那么友好。

4.函數名

兩者有點類似，前綴不一樣，后面都是以【大寫字母開頭】進行區分。

比如：創建任務的函數名：

FreeRTOS的前綴官方有這樣的描述：

靜態（static）函數以 prv 為前綴。比如：prvIdleTask 函數。

API 函數以其返回類型為前綴，void 類型以v為綴。比如：vTaskDelete 函數。

注釋

// /* */ 是兩種最常見注釋的方法，但這兩種 RTOS 基本以【/* */】注釋居多。

注釋的位置也是有講究，通常在代碼所在行上一行，或者在代碼所在行（代碼后面）。

這里主要說明一下，FreeRTOS在代碼中沒有相信注釋函數的功能、參數、返回值等信息。

還是以“創建任務”函數為例：

當然，FreeRTOS的函數注釋信息，在手冊中有相信描述。

縮進

這兩種RTOS縮進方式一樣，都是采用 4 空格：

這里要提醒一下，切記不要 Tab 和空格兩者混用，不然代碼就是一片亂。（在不少新手，或者初級工程中就經常出現這種，代碼簡直不敢看）

單詞縮寫

不同的領域，有不同的縮寫方式。在RTOS中也有一些常見的縮寫單詞，比如：

好了，本文就分享到這里。以上只是列舉了部分典型的編碼風格，更多細節，大家可以抽時間自行研究。