這是一份 RT-Thread 開(kāi)發(fā)人員的開(kāi)發(fā)指引。RT-Thread 做為一份開(kāi)源軟件，它需要由不同 的人采用合作的方式完成，這份文檔是開(kāi)發(fā)人員的一個(gè)指引。RT-Thread 的開(kāi)發(fā)人員請(qǐng)遵 守這樣的編程風(fēng)格。同時(shí)對(duì)于使用 RT-Thread 的用戶(hù)，也可通過(guò)這份文檔了解 RT-Thread 代碼內(nèi)部一些約定從而比較容易的把握到 RT-Thread 的實(shí)現(xiàn)方式。

1.目錄名稱(chēng)

目錄名稱(chēng)如果無(wú)特殊的需求，請(qǐng)使用全小寫(xiě)的形式；目錄名稱(chēng)應(yīng)能夠反應(yīng)部分的意思，例 如各芯片移植由其芯片名稱(chēng)構(gòu)成或芯片類(lèi)別構(gòu)成；components 目錄下能夠反映組件的意義。

2.文件名稱(chēng)

文件名稱(chēng)如果無(wú)特殊的需求（如果是引用其他地方，可以保留相應(yīng)的名稱(chēng)），請(qǐng)使用全小寫(xiě) 的形式。另外為了避免文件名重名的問(wèn)題，一些地方請(qǐng)盡量不要使用通用化、使用頻率高 的名稱(chēng)。

3.頭文件定義

C語(yǔ)言頭文件為了避免多次重復(fù)包含，需要定義一個(gè)符號(hào)。這個(gè)符號(hào)的定義形式請(qǐng)采用如下 的風(fēng)格：

1 #ifndef __FILE_H__

2 #define __FILE_H__

3 /* header file content */

4 #endif

即定義的符號(hào)兩側(cè)采用 “__” 以避免重名，另外也可以根據(jù)文件名中是否包含多個(gè)詞語(yǔ)而 采用 “_” 連接起來(lái)。

4.文件頭注釋

在每個(gè)源文件文件頭上，應(yīng)該包括相應(yīng)的版權(quán)信息，Change Log 記錄：

1 /*

2 * File ： rtthread.h

3 * This file is part of RT-Thread RTOS

4 * COPYRIGHT （C） 2006 - 2012， RT-Thread Development Team

5 *

6 * This program is free software; you can redistribute it and/or modify

7 * it under the terms of the GNU General Public License as published by

8 * the Free Software Foundation; either version 2 of the License， or

9 * （at your option） any later version.

10 *

11 * This program is distributed in the hope that it will be useful，

12 * but WITHOUT ANY WARRANTY; without even the implied warranty of

13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

14 * GNU General Public License for more details.

15 *

16 * You should have received a copy of the GNU General Public License along

17 * with this program; if not， write to the Free Software Foundation， Inc.，

18 * 51 Franklin Street， Fifth Floor， Boston， MA 02110-1301 USA.

19 *

20 * Change Logs：

21 * Date Author Notes

22 * 2006-03-18 Bernard the first version

23 * 2006-04-26 Bernard add semaphore APIs

24 * 。..

25 */

例如采用如上的形式。

5.結(jié)構(gòu)體定義

結(jié)構(gòu)體名稱(chēng)請(qǐng)使用小寫(xiě)英文名的形式，單詞與單詞之間采用 “_” 連接，例如：

1 struct rt_list_node

2 {

3 struct rt_list_node *next;

4 struct rt_list_node *prev;

5 };

其中，“{”，“}” 獨(dú)立占用一行，后面的成員定義使用縮進(jìn)的方式定義。

結(jié)構(gòu)體等的類(lèi)型定義請(qǐng)以結(jié)構(gòu)體名稱(chēng)加上 “_t” 的形式作為名稱(chēng)，例如：

1 typedef struct rt_list_node rt_list_t;

因?yàn)閮?nèi)核中對(duì)象引用方便的緣故，采用了對(duì)象內(nèi)核指針作為類(lèi)型定義的形式，例如：

1 typedef struct rt_timer* rt_timer_t;

6.宏定義

在RT-Thread中，請(qǐng)使用大寫(xiě)英文名稱(chēng)作為宏定義，單詞之間使用 “_” 連接，例如：

向滑動(dòng)查看全部

1 #define RT_TRUE 1

7.函數(shù)名稱(chēng)、聲明

函數(shù)名稱(chēng)請(qǐng)使用小寫(xiě)英文的形式，單詞之間使用 “_” 連接。提供給上層應(yīng)用使用的 API 接口，必須在相應(yīng)的頭文件中聲明；如果函數(shù)入口參數(shù)是空，必須使用 void 作為入口參 數(shù)，例如：

1 rt_thread_t rt_thread_self（void）;

8.注釋編寫(xiě)

請(qǐng)使用英文做為注釋?zhuān)褂弥形淖⑨寣⒁馕吨诰帉?xiě)代碼時(shí)需要來(lái)回不停的切換中英文輸 入法從而打斷編寫(xiě)代碼的思路。并且使用英文注釋也能夠比較好的與中國(guó)以外的技術(shù)者進(jìn) 行交流。

源代碼的注釋不應(yīng)該過(guò)多，更多的說(shuō)明應(yīng)該是代碼做了什么，僅當(dāng)個(gè)別關(guān)鍵點(diǎn)才需要一些 相應(yīng)提示性的注釋以解釋一段復(fù)雜的算法它是如何工作的。對(duì)語(yǔ)句的注釋只能寫(xiě)在它的上 方或右方，其他位置都是非法的。

9.縮進(jìn)及分行

縮進(jìn)請(qǐng)采用 4 個(gè)空格的方式。如果沒(méi)有什么特殊意義，請(qǐng)?jiān)?“{” 后進(jìn)行分行，并在下一 行都采用縮進(jìn)的方式，例如：

1 if （condition）

2 {

3 /* others */

4 }

唯一的例外是 switch 語(yǔ)句，switch-case 語(yǔ)句采用 case 語(yǔ)句與 switch 對(duì)齊的方式， 例如：

1 switch （value）

2 {

3 case value1：

4 break;

5 }

case 語(yǔ)句與前面的 switch 語(yǔ)句對(duì)齊，后續(xù)的語(yǔ)句則采用縮進(jìn)的方式。

分行上，如果沒(méi)有什么特殊考慮，請(qǐng)不要在代碼中連續(xù)使用兩個(gè)以上的空行。

10.大括號(hào)與空格

從代碼閱讀角度，建議每個(gè)大括號(hào)單獨(dú)占用一行，而不是跟在語(yǔ)句的后面，例如：

1 if （condition）

2 {

3 /* others */

4 }

匹配的大括號(hào)單獨(dú)占用一行，代碼閱讀起來(lái)就會(huì)有相應(yīng)的層次而不會(huì)容易出現(xiàn)混淆的情況。

空格建議在非函數(shù)方式的括號(hào)調(diào)用前留一個(gè)空格以和前面的進(jìn)行區(qū)分，例如：

1 if （x 《= y）

2 {

3 /* others */

4 }

5

6 for （index = 0; index 《 MAX_NUMBER; index ++）

7 {

8 /* others */

9 }

建議在括號(hào)前留出一個(gè)空格（涉及的包括 if、for、while、switch 語(yǔ)句），而運(yùn)算表達(dá)式 中，運(yùn)算符與字符串間留一個(gè)空格。另外，不要在括號(hào)的表達(dá)式兩側(cè)留空格，例如：

1 if （ x 《= y ）

2 {

3 /* other */

4 } /* others */

5 }

這樣括號(hào)內(nèi)兩側(cè)的空格是不允許的。

11.trace、log信息

在 RT-Thread 中，普遍使用的 log 方式是 rt_kprintf。rt_kprintf 在 RT-Thread 被實(shí) 現(xiàn)成一個(gè)采用輪詢(xún)、非中斷方式的字串輸出，能夠適合于在中斷這類(lèi)“即時(shí)”顯示日志的場(chǎng) 合。因?yàn)檫@種輪詢(xún)方式的存在，也必然會(huì)影響到日志輸出的時(shí)序關(guān)系。

建議在代碼中不要頻繁的使用 rt_kprintf 作為日志輸出，除非你真正的明白，你的代碼 運(yùn)行占用的時(shí)間多一些也沒(méi)什么關(guān)系。

日志輸出應(yīng)該被設(shè)計(jì)成正常情況下是關(guān)閉狀態(tài)（例如通過(guò)一個(gè)變量或宏就能夠開(kāi)啟），并且 當(dāng)真正輸出日志時(shí)，日志是易懂易定位問(wèn)題的方式?！疤鞎?shū)式”的日志系統(tǒng)是糟糕的，不合 理的。

12.函數(shù)

在內(nèi)核編程中，函數(shù)應(yīng)該盡量精簡(jiǎn)，僅完成相對(duì)獨(dú)立的簡(jiǎn)單功能。函數(shù)的實(shí)現(xiàn)不應(yīng)該太長(zhǎng) ，函數(shù)實(shí)現(xiàn)太長(zhǎng)，應(yīng)該反思能夠如何修改（或拆分）使得函數(shù)更為精簡(jiǎn)、易懂。

13.對(duì)象

RT-Thread 內(nèi)核采用了 C 語(yǔ)言對(duì)象化技術(shù)，命名表現(xiàn)形式是：對(duì)象名結(jié)構(gòu)體表示類(lèi)定義、 對(duì)象名 + 動(dòng)詞短語(yǔ)形式表示類(lèi)方法，例如：

1 struct rt_timer

2 {

3 struct rt_object parent;

4 /* other fields */

5 };

6 typedef struct rt_timer* rt_timer_t;

結(jié)構(gòu)體定義 rt_timer 代表了 timer 對(duì)象的類(lèi)定義；

1 rt_timer_t rt_timer_create（const char* name，

2 void （*timeout）（void* parameter）， void* parameter，

3 rt_tick_t time， rt_uint8_t flag）;

4 rt_err_t rt_timer_delete（rt_timer_t timer）;

5 rt_err_t rt_timer_start（rt_timer_t timer）;

6 rt_err_t rt_timer_stop（rt_timer_t timer）;

rt_timer + 動(dòng)詞短語(yǔ)的形式表示能夠應(yīng)用于 timer 對(duì)象的方法。

在創(chuàng)建一個(gè)新的對(duì)象時(shí)，應(yīng)該思考好，對(duì)象的內(nèi)存操作處理：是否允許一個(gè)靜態(tài)對(duì)象存在 ，或僅僅支持從堆中動(dòng)態(tài)分配的對(duì)象。
責(zé)任編輯:pj