華為軟件編程規范和范例
發布: 2008-4-23 16:04 | 作者: 不詳 | 來源: www.cppblog.com/oosky | 查看: 260次 | 進入軟件測試論壇討論
if (...)
{
// program code
while (index < MAX_INDEX)
{
// program code
} /* end of while (index < MAX_INDEX) */ // 指明該條while語句結束
} /* end of if (...)*/ // 指明是哪條if語句結束
½2-5 ：注釋格式盡量統一，建議使用“/* …… */”
½2-6 ：注釋應考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準確的英文表達
說明：注釋語言不統一，影響程序易讀性和外觀排版，出于對維護人員的考慮，建議使用中文。
〔三〕 =====[ 標識符命名 ]=======
¹3-1 ：標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解
說明：較短的單詞可通過去掉“元音”形成縮寫；較長的單詞可取單詞的頭幾個字母形成縮寫；一些單詞有大家公認的縮寫。
示例：如下單詞的縮寫能夠被大家基本認可。
temp 可縮寫為 tmp ;
flag 可縮寫為 flg ;
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 ：除非必要，不要用數字或較奇怪的字符來定義標識符
示例：如下命名，使人產生疑惑。