本文目錄一覽：
華為c語言編程規範是怎樣的
代碼總體原則
清晰第一。清晰性是易於維護、易於重構的程序必須具備的特徵。
簡潔為美。簡介就是易於理解並且易於實現。
選擇合適的風格，與源代碼風格保持一致。
頭文件
頭文件的設計體現了大部分的系統設計，不合理的頭文件布局是編譯時間過長的根因，實際上是不合理的設計。
頭文件中適合放置接口的聲明，不適合放置實現。
頭文件應當職責單一。
頭文件應向穩定的方向包含。
每一個.c文件應有一個同名的.h文件，用於聲明需要對外公開的接口。
禁止頭文件循環依賴。
禁止包含用不到的頭文件。
頭文件應當自包含。
編寫內部#include保護符(#define保護)。
禁止在頭文件中定義變量。
只能通過包含頭文件的方式使用其他C提供的接口，禁止在C中通過extern的方式使用外部函數接口和變量。
禁止在extern “C”中包含頭文件。
函數
函數設計的精髓：編寫整潔函數，同事把代碼有效組織起來。
一個函數僅完成一個功能。
重複代碼應該儘可能提煉成函數。
避免函數過長，新增函數不超過50行。
避免函數的代碼塊嵌套過深，新增函數的代碼塊嵌套不超過4層。
可重入函數應避免使用共享變量；若需要使用，則應該通過互斥手段對其加以保護。
對參數的合法性檢查，由調用者負責還是接口函數負責，應在項目組模塊內統一規定。缺省由調用者負責。
對函數的錯誤返回碼要全面處理。
設計高扇入，合理扇出（小於7）的函數。扇出是指調用其它函數的數目。扇入是指有多少上級函數調用它。
廢棄代碼要及時清除。
函數參數不變使用const限定。
函數應避免使用全局變量、靜態局部變量和I/O操作，不可避免的地方應集中使用。
檢查函數所有非參數輸入的有效性，如數據文件、公共變量等。
函數的參數個數不超過5個。
在源文件範圍內聲明和定義的所有函數，除非外部可見，否則應該加static關鍵字。
標識符
標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。
產品、項目組內應保持同意的命名分格。
盡量避免名字中出現數字編號，除非邏輯上確實需要。
重構、修改部分代碼時，應該保持和原有代碼風格一致。
文件命令統一採用小寫字符。因為不同系統對文件名大小寫處理會有不同（windows不區分大小寫，但是linux系統則區分）。
全局變量應增加“g_”前綴。
靜態變量應增加“s_”前綴。
禁止使用單字節命名變量，但是允許定義i,j,k作為局部循環變量。
不建議使用匈牙利命名法。
對於數值或者字符串常量的定義，建議採用全大寫字母，單詞之間加下劃線的方式命名。
變量
結構功能單一，不要設計面面俱到的數據結構。
不用或者少用全局變量
防止局部變量與全局變量同名
通訊過程中使用的機構，必須注意字節序。
嚴禁使用未經初始化的變量作為右值。
使用面向接口編程思想，通過API訪問數據。
盡量減少沒有必要的數據類型默認轉換與強制轉換。
宏和常量
用宏定義表達式時，要使用完備的括號。
將宏定義的多條表達式放在大括號中。
使用宏時，不允許參數發生變化。
不允許直接使用魔鬼數字。
除非必要，應儘可能使用函數代替宏。
常量建議用const定義代替宏。
質量
時刻注意易混淆的操作符
必須了解編譯系統的內存分配方式，特別是編譯系統對不同類型的變量的內存分配規則，如局部變量在何處分配、靜態變量在何處分配等。
不僅關注接口，同樣要關注實現。
禁止內存操作越界。
禁止內存泄漏。
禁止引用已經釋放的內存空間。
編程時，要防止差1錯誤。
switch語句必須有default分支。
函數中分配的內存，在函數退出之前要釋放。
不要濫用goto語句。
時刻注意表達式是否會上溢、下溢。
程序效率
在保證軟件系統的正確性、簡潔、可維護性、可靠性及可測試性的前提下，提高代碼的效率。
通過對數據結構、程序算法的優化來提高效率。
將不變條件的計算移到循環體外。
對於多維大數組，避免來回跳躍式訪問數組成員。
創建資源庫，以減少分配對象的開銷。
將多次被調用的“小函數”改為inline函數或者宏實現。
注釋
優秀的代碼可以自我解釋，不通過注釋即可輕易讀懂。
注釋的內容要清楚、明了，含義準確，防止注釋二義性。
修改代碼時，維護代碼周邊的所有注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。
文件頭部應進行注釋，注釋需要列出：版權說明、版本號、生成日期、作者姓名、工號、內容、功能說明、與其他文件的關係、修改日誌等，頭文件的注釋中還應有函數功能的說明。
函數聲明處注釋描述函數功能、性能及用法，包括輸入和輸出參數、函數返回值、可重入的要求等；定義處詳細描述函數功能和實現要點，如實現的簡要步驟、實現的理由、設計約束等。
全局變量要有詳細的注釋，包括對其功能、取值範圍以及存取時注意事項等的說明。
盡量採用工具可以識別的格式注釋。
排版與格式
程序塊採用縮進風格編寫，每級縮進為4個空格。
相對獨立的程序塊之間、變量說明之後必須加空行。
一行只寫一條語句。
對等操作兩邊加空格，注釋符與內容之間加空格。
編譯
使用編譯器的最高告警級別，理解所有的告警，通過修改代碼而不是降低告警級別來消除所有告警。
在產品軟件中，要統一編譯開關、靜態檢查選項以及相應告警清除策略。
可測性
模塊劃分清晰，接口明確，耦合性小，有明確輸入和輸出，否則單元測試實施困難。
在統一項目組或產品組內，調測打印的日誌要有統一的規定。
使用斷言記錄內部假設。
不能用斷言來檢查運行時錯誤。
C語言的書寫規則主要有哪些呢?
從書寫清晰，便於閱讀，理解，維護的角度出發，在書寫程序時
應遵循以下規則:
1.一個說明或一個語句佔一行。
2.用{}
括起來的部分，通常表示了程序的某一層次結構。{}一般與該結構語句的第一個字母對齊，並單獨佔一行。
3.低一層次的語句或說明可比高一層次的語句或說明縮進若干格後書寫。以便看起來更加清晰，增加程序的可讀性。在編程時應力求遵循這些規則，以養成良好的編程風格。
有空格的地方就可以換行!
if(
a
==
b
e
==
c
){}
和
if(
a
==
b
e
==
c
)
{
}
是完全一樣的
C語言的書寫規則主要有哪些呢？
1.
1.1符號命名規則
1.1.1符號名包括模塊名、常量名、標號名、子程序名等。這些名字應該能反映它所代表的實際東西，具有一定的意義，使其能夠見名知義，有助於對程序功能的理解。命名採用匈牙利命名法。規則如下：
(1)所有宏定義、枚舉常數和const變量，用大寫字母命名。在複合詞里用下劃線隔開每個詞。
(2)複合詞中每個單詞的第一個字母大寫。除了規則5.1.1.1以外，避免使用下劃線。
(3)類、類型定義和枚舉型名的第一個字母大寫。
(4)函數名是複合詞的，第一個詞採用全部小寫，隨後每個單詞採用第一個字母大寫，其它字母小寫方式；如果是單個詞的，採用全部小寫方式。
(5)循環變量可採用i, j, k等，不受上述規則限制。
(6) 類的成員變量應採用m_開頭。
(7) 全局變量詞頭為g_ 。
(8) 臨時變量詞頭為tmp_ 。
(9) 對結構體內的變量命名, 遵循變量的具體含義命名原則
(10)用小寫字母的前綴表示變量的類型，前綴的下一個字母用大寫。
表 1
詞頭 類型 詞頭 類型
ch char l long
i integer u unsigned
b boolean p pointer
f float lp long pointer
d double s string
st structure sz ASCII string
by byte n short int
H handle x,y 分別為x,y坐標
dw DWORD fn function
表 2
詞頭 變量名 詞頭 變量名
task task sig signal
sb binary semaphores wd watchdog
sm mutual exclusion tm timer
sc counting semaphores msg message
pipe pipe
例：
#define ARRAY_SIZE 24 /*規則5.1.1.1*/
int g_iFlag;
class MyClass /*規則5.1.1.3*/
{
};
void someFunc( ) /*規則5.1.1.2和5.1.1.4*/
{
int nArray[ARRAY_SIZE];
unsigned char uchByte;
char szName[ ];
char *pszName = szName;
}
(11)有些詞頭（如p和u）可以和其它詞頭組合。
例：WDOG_ID wdId;
WDOG_ID g_wdId; /*全局watchdog Id，故以g_開頭*/
1.1.2名字的長度一般不要過長或過短。過長的名字會增加工作量，使程序邏輯流程變得模糊；過短的名字無法表達符號的實際意義。約定長度範圍：3-31；
1.2數據和函數說明
1.2.1數據說明次序應當規範化，使數據屬性容易查找，也有利於測試、排錯和維護。說明的先後次序應固定，應按邏輯功能排序，邏輯功能塊內建議採用下列順序：整型說明、實型說明、字符說明、邏輯量說明。
1.2.2如果設計了一個複雜的數據結構，應當通過注釋對其變量的含義、用途進行說明。
1.2.3在函數的聲明中使用異常聲明。
如：void f() throw(toobig, toosmall, divzero);
在聲明一個函數時，將它所拋出的異常列出，便於函數的使用者了解可能會發生哪些異常。
1.3 程序注釋
1.3.1程序注釋是程序員與日後的程序讀者之間通信的重要手段之一，注釋分為文件注釋、函數注釋和功能注釋。
1.3.2正規程序的注釋應注意：
——注釋行的數量佔到整個源程序的1/3到1/2。
1.3.3文件注釋位於整個源程序的最開始部分，注釋後空兩行開始程序正文。它包括：
——程序標題。
——目的、功能說明。
——文件作者、最後修改日期等說明。
例：
./********************************************************************
（空一行）
標題: Demo.c
功能: 測試VxWorks的各種系統調用.
說明:
該程序測試各種VxWorks的系統調用函數。包括任務（taks）的創建、掛起及任務間通過信號燈實現同步，通過消息隊列 進行通訊。
程序創建了兩個任務：一個高優先級的任務和一個低優先級的任務。兩個任務間通過一個二進制的信號燈進行同步，通過消息隊列進行通訊。
當前版本： x.x
修改信息： 2000.06.05 John， Initial Version
2000.07.05 Tom， Bug xxxx fixed
**************************************************************/
(空2行，開始程序正文)
1.3.4 函數注釋通常置於每函數或過程的開頭部分，它應當給出函數或過程的整體說明對於理解程序本身具有引導作用。一般包括如下條目：
——模塊標題。
——有關本模塊功能和目的的說明。
——調用格式
——接口說明：包括輸入、輸出、返回值、異常。
——算法。如果模塊中採用了一些複雜的算法。
例：
file://（/注釋開頭應和上一函數空兩行）
（注釋開頭與上一函數最後一行間隔兩行）
/********************************************************************
標題：assignmentComplete
功能：BSC=MSC消息生成函數，生成assignment_complete指配完成消息(BSMAP消息) .
格式：
int assignmentComplete(int iCellId, int iServiceChannnelNum, char *pszMSGData) throw(exception1, exception2)
輸入：
int iCellId: MS所在的小區識別
iCellId取值：0x00-——0xff
int iServiceChannnelNum：MS所佔的業務信道號碼
輸出：
char * pszMSGData：指配完成消息數據
返回值: 0x00正常
異常：exception1異常情況1, exception2異常情況2
********************************************************************/
( 注釋後直接開始程序正文，不空行。)
1.3.5功能性注釋嵌在源程序體中，用於描述其後的語句或程序段做什麼工作，也就是解釋下面要做什麼，或是執行了下面的語句會怎麼樣。而不要解釋下面怎麼做，因為解釋怎麼做常常與程序本身是重複的。
例：
/*把 amount 加到 total中*/
total = amount + total;
這樣的注釋僅僅是重複了下面的程序，對於理解它的工作並沒有什麼作用。而下面的注釋，有助於讀者理解。
/*將每月的銷售額amount加到年銷售額total中*/
total = amount + total;
1.4 函數編寫應儘可能短小精悍，一般不超過兩屏，以便於調試和理解。
1.5語句結構
為保證語句結構的清晰和程序的可讀性，在編寫軟件程序時應注意以下幾個方面的問題：
——在一行內只寫一條語句，並採用空格、空行和移行保證清楚的視覺效果。
——每一個嵌套的函數塊，使用一個TAB縮進（可以設定為4個空格），大括號必須放在條件語句的下一行，單獨成一行，便於匹對：
如，有一段程序如下：
for(i=1;in-1;i++){ t=1; for(j=i+1;jn;j++){
if(a[j]a[t] ) t=j; if(t!=i ){work=a[t];a[t]=a[I];a[I]=work;}}}
應寫為
for( i=1; in-1; i++)
{
t=1;
for(j = i+1; jn; j++)
{
if(a[i]a[j])
t=j;
if(t!=1)
{ .5.
Q/ECC/BJ 010—2001
work=a[t];
a[t]=a[i];
a[i]=work;
}
}
}
——文件之中不得存在無規則的空行，比如說連續十個空行。
一般來講函數與函數之間的空行為2-3行；
在函數體內部，在邏輯上獨立的兩個函數塊可適當空行，一般為1-2行。
——程序編寫首先應考慮清晰性，不要刻意追求技巧性而使得程序難以理解。
——每行長度盡量避免超過屏幕寬度，應不超過80個字符。
——除非對效率有特殊要求，編寫程序要作到清晰第一，效率第二。
——儘可能使用函數庫。
——盡量用公共過程或子程序去代替重複的功能代碼段。要注意，這個代碼應具有一個獨立的功能，不要只因代碼形式一樣便將其抽出組成一個公共過程或子程序。
——使用括號清晰地表達算術表達式和邏輯表達式的運算順序。如將 x=a*b/c*d 寫成 x=(a*b/c)*d可避免閱讀者誤解為x=(a*b)/(c*d)。
——避免不必要的轉移。
——避免採用過於複雜的條件測試。
——避免過多的循環嵌套和條件嵌套。
——建議不要使用 *=，^=, /=等運算符。
——一個函數不要超過200行。一個文件應避免超過2000行。
——盡量避免使用go to語句。
——避免採用多賦值語句，如x = y = z ;
——不鼓勵採用?:操作符，如z = (ab)?a:b;
——不要使用空的if else 語句。如
if(cMychar = ‘A’)
if(cMychar = ‘Z’)
printf(“This is a letter \n”);
else
printf(“This is not a letter \n”);
else到底是否定哪個if容易引起誤解。可通過加{}避免誤解。
——盡量減少使用“否定”條件的條件語句。如：
把 if( !( (cMychar’0’) || (cMychar’9’) ) )
改為if( (cMychar=’0’) (cMychar=’9’)
原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/155318.html
微信掃一掃 
支付寶掃一掃 