良好的程式設計習慣 (三)標示符命名

2021-08-27 09:22:03 字數 2155 閱讀 3947

¹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-1:除非必要,不要用數字或較奇怪的字元來定義識別符號。

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

#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-2:在同一軟體產品內,應規劃好介面部分識別符號(變數、結構、函式及常量)的命名,防

止編譯、鏈結時產生衝突。

說明:對介面部分的識別符號應該有更嚴格限制,防止衝突。如可規定介面部分的變數與常

量之前加上「模組」標識等。

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

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

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-4:除了編譯開關 /標頭檔案等特殊應用,應避免使用_example_test_之類以下劃線開始和

結尾的定義。

良好的程式設計習慣

最近,看到一些程式設計技巧有意無意的去使用,然而這些技巧看起來很華麗,但有礙於良好的程式設計習慣。比如在輸出乙個陣列時,可以有以下兩種寫法 for int i 0 i len i 良好的習慣 cout arr i endl for int i 0 i len cout arr i endl 不好的習...

良好的程式設計習慣

1.避免使用大檔案,如果乙個檔案裡的 超過300 400行,必須考慮將 分開到不同類中。2.避免寫太長的方法,乙個典型的方法 在1 30行之間。如果乙個方法發 超過30行,應該考慮將其分解為不同的方法。3.方法名需能看出它作什麼,別使用會引起誤解的名字。如果名字一目了然,就無需用文件來解釋方法的功能...

良好的程式設計習慣

檔名可使用a z a z 0 9 減號 和下劃線 等字元 禁止使用特殊字元,如 檔名之間不能有空格 首頁檔名是網頁伺服器預設的,所以檔名必須按照網頁伺服器的定義命名,通常為index.htm index.html default.htm 大部分網頁伺服器都區分大小寫,最好統一使用小寫英文,尤其是關鍵...