有感程序編寫不夠規范
- 發布于:2023-09-26
- 共 194 人圍觀
看過斑竹及西樓還有其他的高手寫的東西,讀起來覺得挺費勁,一是自己的思維沒達到那種層次,二是對命令函數還浮于表面,三就是非常不習慣他們對常數、變量的命名方式。呵呵,前兩點只有自己加把勁了,第三點不記得是誰曾經發貼呼吁程序編寫要規范,我知道是我自己的不規范習慣釀成讀別人的東西那么累。因此我翻了翻互聯網,找了篇關于軟件代碼編寫規范的文章。由于太長了,所以只引用一小段,最后有個網址,有興趣的朋友可以看看,當然如果你們有更好的文章也介紹給我啊,謝謝了。
http://www.shenyuyang.com/main/20049/2004911899.htm
《軟件代碼編寫規范指導》
作者:不詳發布時間:2004-9-11
1. 前言
凡是都有一個來龍去脈,都有一定的規則可循。編碼也是一樣,需要統一思想統一格式統一邏輯。
作為一個程序,程序的可維護性(可讀性)是第一位的。一個難于維護的程序只不過是無謂勞動。要記住:程序是寫給別人看的,不是寫給計算機看的。程序的邏輯結構是第二位的。程序的邏輯結構混亂就是編程人員的思路混亂,混亂的思路不可能保證一個大型的項目能按照預想的方向發展。在一個大型的項目中,每個人的編程習慣與邏輯習慣必須保持一致。程序的格式是第三位的。良好的空格和縮進習慣將使代碼易讀、易改,會極大減少以后的維護工作量。程序的功能實現是第四位的。
2. 目的
人們往往希望統一規范,可是就是不指導如何統一規范,而且有了規范以后,又覺得遵循規范很是不方便,而且不同的人對規范的執行有不同的方法。我們的目的是建立一個規范,一個可以方便的去執行的規范,然后按照這個規范,一路執行下去,直到達到我們的目的。
3. 規范
3.1 命名原則
3.1.1 規則
a) 規則:常量必須為大寫,如
Const MAX_PACKET_SIZE 64
Const MAX_FAILUREC_COUNT 10
b) 縮寫規則:如果能用單詞,就不要用縮寫,如果變量名/函數名太長(大于25個字符),最好用單詞首部音節代替單詞。如:應使用AltExpEval代替AlternateExpressionEvaluation。
c) 大小寫混合規則:用單詞首部大寫區分不同單詞,而不應用下劃線,更不應用全小寫或全大寫(常量除外) 。如:應使用ShortcutMenus,而不是Shortcut_Menus、Shortcutmenus、SHORTCUTMENUS、SHORTCUT_MENUS。
d) 首字/詞規則:變量的首詞應為三個小寫字母(有g或m前綴的除外),函數名的首詞必須為頭一個字母大寫的單詞或縮寫;
e) 復數規則:集合類命名應使用復數。如:類名為CAxis,其集合應命名為CAxes;類名Window,其集合名為Windows。當單詞復數形式與單詞完全一樣時,在單詞后加Collection作為其集合命名,如類名Series,集合名SeriesCollection。
f) 風格一致規則:所有變量的命名風格在項目中應一致,并需要對所有的縮寫命名作說明(寫入程序文檔) 。當決定使用縮寫而不是單詞全稱時必須保證在整個項目中該單詞都以同樣的縮寫形式出現,如果頻繁的在Cnt和Count之間切換會帶來不必要的混淆。
g) 詞序規則:過程名和函數名應以動詞開頭,以名詞結尾,如應當使用InitNameArray,而不是NameArrayInit。類名、變量名應以名詞結尾。
......
標簽: