學習嵌入式的同窗應該首先掌握嵌入式編碼規範,這樣才能更好的嵌入式系統。數組
下面就從這幾個方面講解一下嵌入式c編碼規範。數據結構
註釋風格、排版風格、頭文件風格、變量定義、宏定義、函數多線程
1 註釋風格socket
1.1 註釋的原則是有助於對程序的閱讀和理解,註釋不宜太多也不能太少。註釋語言必須準確、易懂、簡潔,沒有歧義性。函數
1.2 程序文件頭部代碼應進行註釋。註釋必須列出:版權說明、版本號、生成日期、做者、內容、功能、與其餘文件的關係、修改日誌等。頭文件的註釋中還應有函數功能簡要說明。性能
/*學習
* Copyright(C), 2007-2008, Red Hat Inc. // 版權聲明測試
* File name: // 文件名編碼
* Author: // 做者線程
* Version: // 版本
* Date: // 完成日期
* Description: // 描述本文件的功能,與其餘模塊的關係
* Function List: // 主要函數的列表,每條記錄應包括函數名及功能簡要說明
* History: // 修改歷史,包括每次修改的日期、修改者和修改內容簡述
*/
1.3 函數頭部應進行註釋,列出函數的功能、輸入參數、輸出參數、返回值、調用關係等。
/*
* Function: // 函數名稱
* Description: // 函數功能、性能等的描述
* Calls: // 被本函數調用的函數清單
* Called By: // 調用本函數的函數清單
* Input: // 輸入參數說明,包括每一個參數的做用
* Output: // 輸出參數說明,有時經過指針參數返回一些變量值
* Return: // 函數返回值的說明
* Others: // 其餘說明
*/
1.4 對於全部有特定含義的變量、常量、宏、結構體等數據結構,若是其命名不是充分自注釋的,在聲明時都必須加上註釋,說明其實際含義。變量、常量、宏的註釋應放在其上方或右方。
1.5 全局變量要有較詳細的註釋,包括功能,取值範圍,哪些函數訪問它,訪問時的注意事項。
1.6 爲使程序排版整齊,方便閱讀和理解,註釋也要進行縮進和對齊。
void example_function( void )
{
/* comments one */
unsigned int min_port, max_port;
/* comments two */
if ...
}
1.7 在複雜程序塊的結束行右方加註釋,以代表某程序塊的結束。
示例:
if (...)
{
...
while ( ... )
{
...
} /* while ( ... )循環語句結束*/
...
} /* end of if (...)語句結束 */
2 排版風格
2.1 相對獨立的程序塊之間、變量聲明以後必須加空行。
int conn_fd;
int ret;
conn_fd = socket(AF_INET, SOCK_STREAM,0);
if (conn_fd < 0) {
perror("socket create");
}
2.2 程序塊要採用縮進風格編寫,縮進爲4個空格或一個Tab鍵。
2.3 對於較長的語句(超過個80字符)要分紅多行書寫,劃分出的新行要進行適當的縮進,使排版整齊,語句可讀。對於參數較長的函數也要劃分紅多行。
ret = connect(conn_fd, (struct sockaddr *)&serv_addr,
sizeof (struct sockaddr));
2.4 一行只寫一條語句,不容許把多個短語句寫在一行中。
如下語句是不規範的:
min_port = 1; max_port = 65535;
應該以下書寫:
min_port = 1;
max_port = 65535;
2.5 if、for、do、while、case、switch、default等語句各自佔一行,且if、for、do、while等語句的執行語句部分不管多少都要加括號{ }。
如下語句是不規範的:
if (conn_fd < 0) perror("socket create");
應該以下書寫:
if (conn_fd < 0) {
perror("socket create");
}
2.6 ‘{’ 和 ‘}’ 要獨佔一行
for (i=1; i<argc; i++)
{
...
}
或者在代碼中‘{’與for語句同行,‘{’前面要有一個空格。
for (i=1; i<argc; i++) {
...
}
2.7 空格的使用
(1)如下語句在逗號後面加空格。
int min_port, max_port;
(2)"+"、"-"、"*"、"="等算術運算符兩邊都有一個空格。
a = i + j;
(3)"<"、">="等比較操做符兩邊都有一個空格。
if (conn_fd < 0) {
(4)"!"、"~"、"++"、"--"、"&"(地址運算符)等單目操做符先後不加空格。
i++;
(5)"->"、"."先後不加空格。
portinfo.min_port = i * seg_len + 1;
3 變量定義
3.1 變量命名要清晰明瞭,有明確含義,同時使用完整的單詞或你們基本能夠理解的縮寫,避免令人產生誤解。
示例:
temp能夠簡寫爲tmp
message能夠簡寫爲msg
3.2 對於變量命名,禁止使用單個字符(如i、j、k),建議除了要有具體含義外,還能代表其數據類型等,但i、j、k做爲局部循環變量是容許的。
int iwidth; // i代表該變量爲int型,width指明是寬度
3.3 在Linux下變量命名通常是全小寫加下劃線的風格。
通常使用:
int min_port;
通常不使用:
int minPort;
3.4 在多線程程序中使用全局變量,應注意對變量操做的原子性。
3.5 應避免局部變量與全局變量同名。
3.6 嚴禁使用未經初始化的變量做爲右值。在C程序中,引用未經賦值的指針,常常會引發程序崩潰。
如下代碼在Linux下將致使錯誤,緣由在於:沒有使p_string指向某個內存空間的狀況下,即對其進行操做是錯誤的。
char *p_string;
p_sting[0] = ‘a’;
應先進行初始化:
char *p_string;
p_string = (char *)malloc(BUFF_SIZE); // 這裏假設BUFF_SIZE已定義
p_sting[0] = ‘a’;
4 宏定義
4.1 代碼中儘可能少使用字面常量,而使用宏常量。
4.2 宏定義時宏名儘可能大寫
4.3 若是宏名由多個單詞組成,那麼個單詞中間要加_
#define BUFF_SIZE 1024
input_data = (char *)malloc(BUFF_SIZE);
4.4 用宏定義表達式時,要使用完備的括號。
以下定義的宏存在必定的風險:
#define GET_AREA(a,b) a*b
應該定義爲:
#define GET_AREA(a,b) ((a)*(b))
4.5 若宏中有多條語句,應該將這些語句放在一對大括號中。
下面語句中只有宏的第一條表達式被執行。
#define INTI_RECT_VALUE( a, b )\
a = 0;\
b = 0;
for (index = 0; index < RECT_TOTAL_NUM; index++)
INTI_RECT_VALUE( rect.a, rect.b );
正確的用法應爲:
#define INTI_RECT_VALUE( a, b ) {\
a = 0;\
b = 0;\
}
for (index = 0; index < RECT_TOTAL_NUM; index++) {
INTI_RECT_VALUE( rect[index].a, rect[index].b );
}
5函數定義
5.1 一個函數完成一個特定的功能,不該嘗試在一個函數中實現多個不相關的功能。
5.2 檢查函數全部輸入參數的有效性,好比指針型參數要判斷是否爲空,數組成員參數判斷是否越界。
5.3 一個函數的規模應限制在200行之內(不包括空行和註釋行)。
5.4 函數的功能應該是能夠預測的,也就是隻要輸入數據相同就應產生一樣的預期輸出。
5.5 函數的參數不宜過多,以1~3個爲宜。
5.6 函數名應準確描述函數的功能,通常以動詞加賓語的形式命名。
void print_record( struct *p_record, int record_len) ;
5.7 函數的返回值要清楚、明瞭,讓使用者不容易忽視錯誤狀況。函數的每種出錯返回值的意義要清晰、明確,防止使用者誤用,理解錯誤或忽視錯誤返回碼。
5.8 若是多段代碼重複作同一件事情,那麼應該考慮把重複功能實現爲一個函數。
5.9 減小函數自己或函數間的遞歸調用。
遞歸調用特別是函數間的遞歸調用(如A->B->C->A),影響程序的可理解性;遞歸調用通常都佔用較多的系統資源(如棧空間);遞歸調用對程序的測試不利。
6頭文件風格
6.1 頭文件可保存以下內容:宏定義、類型定義、結構體定義、變量聲明、函數聲明
不要有以下內容:變量定義、函數定義
6.2 頭文件必需要有重複包含限制
#ifndef _ALPS_H
#define _ALPS_H
...
#endif