計(jì)算機(jī)源代碼編寫(xiě)規(guī)范.doc

《計(jì)算機(jī)源代碼編寫(xiě)規(guī)范.doc》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。

1、計(jì)算機(jī)源代碼編寫(xiě)規(guī)第一章概述規(guī)制定原則1方便代碼的交流和維護(hù)。2不影響編碼的效率，不與大眾習(xí)慣沖突。3使代碼更美觀、閱讀更方便。4使代碼的邏輯更清晰、更易于理解。術(shù)語(yǔ)定義Pascal大小寫(xiě)將標(biāo)識(shí)符的首字母和后面連接的每個(gè)單詞的首字母都大寫(xiě)?？梢詫?duì)三字符或更多字符的標(biāo)識(shí)符使用Pascal大小寫(xiě)。例如：BackColorCamel大小寫(xiě)標(biāo)識(shí)符的首字母小寫(xiě)，而每個(gè)后面連接的單詞的首字母都大寫(xiě)。例如：backColor文件命名組織1.3.1文件命名1文件名遵從Pascal命名法，無(wú)特殊情況，擴(kuò)展名小寫(xiě)。2使用統(tǒng)一而又通用

2、的文件擴(kuò)展名：C#類.cs1.3.2文件注釋1在每個(gè)文件頭必須包含以下注釋說(shuō)明/*----------------------------------------------------------------//Copyright(C)2011市鵬為軟件//所有。////文件名：//文件功能描述：//////創(chuàng)建標(biāo)識(shí)：////修改標(biāo)識(shí)：//修改描述：////修改標(biāo)識(shí)：//修改描述：//----------------------------------------------------------------

3、*/文件功能描述只需簡(jiǎn)述，具體詳情在類的注釋中描述。創(chuàng)建標(biāo)識(shí)和修改標(biāo)識(shí)由創(chuàng)建或修改人員的拼音或英文名加日期組成。如：軼20040408一天有多個(gè)修改的只需做一個(gè)在注釋說(shuō)明中做一個(gè)修改標(biāo)識(shí)就夠了。在所有的代碼修改處加上修改標(biāo)識(shí)的注釋。第二章代碼外觀2.1列寬代碼列寬控制在110字符左右。2.2換行當(dāng)表達(dá)式超出或即將超出規(guī)定的列寬，遵循以下規(guī)則進(jìn)行換行1、在逗號(hào)后換行。2、在操作符前換行。3、規(guī)則1優(yōu)先于規(guī)則2。當(dāng)以上規(guī)則會(huì)導(dǎo)致代碼混亂的時(shí)候自己采取更靈活的換行規(guī)則。2.3縮進(jìn)縮進(jìn)應(yīng)該是每行一個(gè)Tab(4個(gè)空格)，不

4、要在代碼中使用Tab字符。VisualStudio.Net設(shè)置：工具->選項(xiàng)->文本編輯器->C#->制表符->插入空格2.4空行空行是為了將邏輯上相關(guān)聯(lián)的代碼分塊，以便提高代碼的可閱讀性。在以下情況下使用兩個(gè)空行1、接口和類的定義之間。2、枚舉和類的定義之間。3、類與類的定義之間。在以下情況下使用一個(gè)空行1、方法與方法、屬性與屬性之間。2、方法中變量聲明與語(yǔ)句之間。3、方法與方法之間。4、方法中不同的邏輯塊之間。5、方法中的返回語(yǔ)句與其他的語(yǔ)句之間。6、屬性與方法、屬性與字段、方法與字段之間。7、注釋與它注釋的

5、語(yǔ)句間不空行，但與其他的語(yǔ)句間空一行。2.5空格在以下情況中要使用到空格1、關(guān)鍵字和左括符“(”應(yīng)該用空格隔開(kāi)。如while(true)注意在方法名和左括符“(”之間不要使用空格，這樣有助于辨認(rèn)代碼中的方法調(diào)用與關(guān)鍵字。2、多個(gè)參數(shù)用逗號(hào)隔開(kāi)，每個(gè)逗號(hào)后都應(yīng)加一個(gè)空格。3、除了.之外，所有的二元操作符都應(yīng)用空格與它們的操作數(shù)隔開(kāi)。一元操作符、++及--與操作數(shù)間不需要空格。如a+=c+d;a=(a+b)/(c*d);while(d++=s++){n++;}PrintSize(“sizeis“+size+“”)

6、;4、語(yǔ)句中的表達(dá)式之間用空格隔開(kāi)。如for(expr1;expr2;expr3)2.6括號(hào)-()1、左括號(hào)“(”不要緊靠關(guān)鍵字，中間用一個(gè)空格隔開(kāi)。2、左括號(hào)“(”與方法名之間不要添加任何空格。3、沒(méi)有必要的話不要在返回語(yǔ)句中使用()。如if(condition)Array.Remove(1)return12.7花括號(hào)-{}1、左花括號(hào)“{”放于關(guān)鍵字或方法名的下一行并與之對(duì)齊。如if(condition){}publicintAdd(intx,inty){}2、左花括號(hào)“{”要與相應(yīng)的右花括號(hào)“}”對(duì)齊。3、

7、通常情況下左花括號(hào)“{”單獨(dú)成行，不與任何語(yǔ)句并列一行。4、if、while、do語(yǔ)句后一定要使用{}，即使{}號(hào)中為空或只有一條語(yǔ)句。如if(somevalue==1){somevalue=2;}5、右花括號(hào)“}”后建議加一個(gè)注釋以便于方便的找到與之相應(yīng)的{。如while(1){if(valid){}//ifvalidelse{}//notvalid}//endforever第三章程序注釋3.4注釋概述1、修改代碼時(shí)，總是使代碼周圍的注釋保持最新。2、在每個(gè)例程的開(kāi)始，提供標(biāo)準(zhǔn)的注釋樣本以指示例程的用途、假設(shè)和

8、限制很有幫助。注釋樣本應(yīng)該是解釋它為什么存在和可以做什么的簡(jiǎn)短介紹.3、避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過(guò)在批注變量聲明時(shí)，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共制表位處對(duì)齊。4、避免雜亂的注釋，如一整行星號(hào)。而是應(yīng)該使用空白將注釋同代碼分開(kāi)。5、避免在塊注釋的周圍加上印刷框。這樣看起來(lái)可能很漂亮，但是難于維護(hù)。6、在部署發(fā)布之前，移除