命名的基本原則

2021-10-10 16:27:24 字數 1220 閱讀 2014

2 命名的基本原則

(1)識別符號的命名要清晰、明了,有明確含義,同時使用完整的單詞或大家基本可以理解的縮寫,避免使人產生誤解——盡量採用採用英文單詞或全部中文全拼表示,若出現英文單詞和中文混合定義時,使用連字元「_」將英文與中文割開。較短的單詞可通過去掉「母音」形成縮寫;較長的單詞可取單詞的頭幾個字母形成縮寫;一些單詞有大家公認的縮寫。例如:temp->tmp、flag->標誌暫存器、statistic->stat、increment->inc、message->msg等縮寫能夠被大家基本認可。

(2)命名中若使用特殊約定或縮寫,則要有注釋說明。應該在原始檔的開始之處,對檔案中所使用的縮寫或約定,特別是特殊的縮寫,進行必要的注釋說

(3)對於變數命名,禁止取單個字元(如i 、j 、k… ),建議除了要有具體含義外,還能表明其變數型別、資料型別等,但i 、j 、k 作區域性迴圈變數是允許的。變數,尤其是區域性變數,如果用單個字元表示,很容易敲錯(如i寫成j),而編譯時又檢查不出來,有可能為了這個小小的錯誤而花費大量的查錯時間。

(4)除非必要,不要用數字或較奇怪的字元來定義識別符號。

(5)命名規範必須與所使用的系統風格保持一致,並在同一專案中統一。

(6)在同一軟體產品內,應規劃好介面部分識別符號(變數、結構、函式及常量)的命名,防止編譯、鏈結時產生衝突。對介面部分的識別符號應該有更嚴格限制,防止衝突。如可規定介面部分的變數與常量之前加上「模組」標識等。

(7)用正確的反義詞組命名具有互斥意義的變數或函式等。

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

ass/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(byteuser_name);

int delete_user(byteuser_name);

(8)除了編譯開關/ 標頭檔案等特殊應用,應避免使用example_test 之類以下劃線開始和結尾的定義。

超越基本原則

techtarget中國 techtarget中國原創 因為持續要求減少it成本,dba們不能再被看作是主要的成本負擔。相反,dba們必須努力於被公司認可和證明他們的價值。本篇文章將集中講述兩方面內容 你作為乙個dba需要具有的技術 硬 技能和非技術 軟 技能。我還會提供建議關於怎樣同管理層打交道和...

voip基本原則

ip 的五項基本原則 ip 系統建設應遵循五項基本原則,它們是 延時400毫秒的基本原則,99.9999 可靠 電信原則,網路的開發原則,後方管理的保障原則。1 延遲400毫秒的基本原則 能否將語音業務整合到資料網路中,關鍵就是如何保證qos。對於ip 而言,保證其qos就怎樣保證語音傳輸的最低延遲...

測試的基本原則

原則1 測試說明缺陷的存在,而不能說明缺陷不存在 即使在測試過程中沒有發現失效,也不能證明證明沒有缺陷,即 零缺陷是不可能的。原則2 窮盡測試是不可能的 進行窮盡測試 輸入和前提條件的所有組合 是不可行的,除非是小型案例 所以我們應利用風險分析 測試技術和優先順序確定測試工作量。原則3 測試的盡早介...