華為C語言程式設計規範 識別符號命名

2021-07-13 14:50:13 字數 2217 閱讀 2692

3-1:識別符號的命名要清晰、明了,有明確含義,同時使用完整的單詞或大家基本可以理解的縮寫,避免使人產生誤解。

說明:較短的單詞可通過去掉「母音」形成縮寫;較長的單詞可取單詞的頭幾個字母形成縮寫;一些單詞有大家公認的縮寫。示例:如下單詞的縮寫能夠被大家基本認可。

temp 可縮寫為 tmp ;

flag 可縮寫為 *** ;

statistic 可縮寫為 stat ;

increment 可縮寫為 inc ;

message 可縮寫為 msg ;

3-2:命名中若使用特殊約定或縮寫,則要有注釋說明。

說明:應該在原始檔的開始之處,對檔案中所使用的縮寫或約定,特別是特殊的縮寫,進行必要的注釋說明。

3-3:自己特有的命名風格,要自始至終保持一致,不可來回變化。

說明:個人的命名風格,在符合所在專案組或產品組的命名規則的前提下,才可使用。(即命名規則中沒有規定到的地方才可有個人命名風格)。

3-4:對於變數命名,禁止取單個字元(如i、j、k...),建議除了要有具體含義外,還能表明其變數型別、資料型別等,但i、j、k 作區域性迴圈變數是允許的。

說明:變數,尤其是區域性變數,如果用單個字元表示,很容易敲錯(如i 寫成j),而編譯時又檢查不出來,有可能為了這個小小的錯誤而花費大量的查錯時間。

示例:下面所示的區域性變數名的定義方法可以借鑑。

int liv_width

其變數名解釋如下:

l 區域性變數(local) (其它:g 全域性變數(global)...)

i 資料型別(interger)

v 變數(variable) (其它:c 常量(const)...)

width 變數含義

這樣可以防止區域性變數與全域性變數重名。

3-5:命名規範必須與所使用的系統風格保持一致,並在同一專案中統一,比如採用unix的全小寫加下劃線的風格或大小寫混排的方式,不要使用大小寫與下劃線混排的方式,用作特殊標識如標識成員變數或全域性變數的m_和g_,其後加上大小寫混排的方式是允許的。

示例: add_user 不允許,add_user、adduser、m_adduser 允許。

3-6:除非必要,不要用數字或較奇怪的字元來定義識別符號。

示例:如下命名,使人產生疑惑。

#define _example_0_test_

#define _example_1_test_

void set_sls00( byte sls );

應改為有意義的單詞命名

#define _example_unit_test_

#define _example_assert_test_

void set_udt_msg_sls( byte sls );

3-7:在同一軟體產品內,應規劃好介面部分識別符號(變數、結構、函式及常量)的命名,防止編譯、鏈結時產生衝突。

說明:對介面部分的識別符號應該有更嚴格限制,防止衝突。如可規定介面部分的變數與常量之前加上「模組」標識等。

3-8:用正確的反義詞組命名具有互斥意義的變數或相反動作的函式等。

說明:下面是一些在軟體中常用的反義詞組。

add / remove begin / end create / destroy

insert / delete first / last get / release

increment / decrement put / get

add / delete lock / unlock open / close

min / max old / new start / stop

next / previous source / target show / hide

send / receive source / destination

cut / paste up / down

示例:int min_sum;

int max_sum;

int add_user( byte *user_name );

int delete_user( byte *user_name );

3-9:除了編譯開關/標頭檔案等特殊應用,應避免使用_example_test_之類以下劃線開始和結尾的定義。

軟體程式設計規範總則 3 識別符號命名

3 1 識別符號的命名要清晰 明了,有明確含義,同時使用完整的單詞或大家基本可以理解的縮寫,避免使人產生誤解。說明 較短的單詞可通過去掉 母音 形成縮寫 較長的單詞可取單詞的頭幾個字母形成縮寫 一些單詞有大家公認的縮寫。示例 如下單詞的縮寫能夠被大家基本認可。temp 可縮寫為 tmp flag 可...

C語言的識別符號命名規則

c語言的識別符號命名規則 c語言的識別符號一般應遵循如下的命名規則 1 識別符號必須以字母a z a z或下劃線開頭,後面可跟任意個 可為0 字元,這些字元可以是字母 下劃線和數字,其他字元不允許出現在識別符號中。2 識別符號區分大小寫字母 3 識別符號的長度,c89規定31個字元以內,c99規定6...

Java中的識別符號命名規範

包名 多個單詞組成時所有字母小寫 例 package com.itcast 類名和介面 多個單詞組成時所有單詞的首字母大寫 例 helloworld 變數名和函式名 多個單詞組成時第乙個單詞首字母小寫,其他單詞首字母大寫 例 lastaccesstime gettime 常量名 多個單詞組成時,字母...