.NET開發編程規范
第1章程序的版式
版式雖然不會影響程序的功能，但會影響可讀性。程序的版式追求清晰、美觀，是程序風格的重要構成因素。
可以把程序的版式比喻為"書法"。好的"書法"可讓人對程序一目了然，看得興致勃勃。差的程序"書法"如螃蟹爬行，讓人看得索然無味，更令維護者煩惱有加。
1.1 版本和版權聲明
版本和版權的聲明寫在文件的開頭，包含內容如下：
1、版權信息
2、摘要
3、當前版本
4、作者
5、修改作者
6、完成日期
7、版本歷史信息
例：
///<copyright> Copyright (c) 2006,有限公司</copyright> ///<copyright> All rights reserved.</copyright> ///<abstract>描述文件的內容，實現的功能和算法等內容</abstract> ///<current_version>當前版本</current_version> ///<author>作者</author> ///<finish_date>完成日期</finish_date> ///<replace_version>取代版本</replace_version> ///<modify>修改</modify> ///<modify_author>修改作者</modify_author> ///<modify_date>修改日期</modify_date> |
版本版權聲明示例 |
在C#中代碼注釋這樣寫的好處是Visual Stuidio能夠在編譯的時候自動生成xml格式的注釋文檔。
1.2空行
空行起著分隔程序段落的作用。空行得體（不過多也不過少）將使程序的布局更加清晰。空行不會浪費內存，雖然打印含有空行的程序是會多消耗一些紙張，但是值得。所以不要舍不得用空行。
在每個類聲明之后、每個函數定義結束之后都要加空行。參見示例1-2（a）在一個函數體內，邏揖上密切相關的語句之間不加空行，其它地方應加空行分隔。參見示例1-2（b ）
// 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } | // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } |
示例1-2(a) 函數之間的空行示例1-2(b) 函數內部的空行
1.3 代碼行
(1)一行代碼只做一件事情，如只定義一個變量，或只寫一條語句。這樣的代碼容易閱讀，并且方便于寫注釋。
(2)if、for、while、do等語句自占一行，執行語句不得緊跟其后。不論執行語句有多少都要加{}。這樣可以防止書寫失誤。
示例1-3（a）為風格良好的代碼行，示例1-3（b）為風格不良的代碼行。
int width;// 寬度 int height; // 高度 int depth;// 深度 |
int width, height, depth; // 寬度高度深度 |
x = a + b; y = c + d; z = e + f; | X ＝ a + b; y = c + d;z = e + f; |
if (width < height) { dosomething(); } | if (width < height) dosomething(); |
for (initialization; condition; update) { dosomething(); } // 空行 other(); | for (initialization; condition; update) dosomething(); other();
|
示例1-3(a) 風格良好的代碼行示例1-3(b) 風格不良的代碼行
【建議】盡可能在定義變量的同時初始化該變量（就近原則）
如果變量的引用處和其定義處相隔比較遠，變量的初始化很容易被忘記。如果引用了未被初始化的變量，可能會導致程序錯誤。本建議可以減少隱患。例如
int width = 10; // 定義并初紿化width
int height = 10; // 定義并初紿化height
int depth = 10; // 定義并初紿化depth
1.4 代碼行內的空格
(1)關鍵字之后要留空格。象const、case 等關鍵字之后至少要留一個空格，否則無法辨析關鍵字。象if、for、while等關鍵字之后應留一個空格再跟左括號'（'，以突出關鍵字。
(2)函數名之后不要留空格，緊跟左括號'（'，以與關鍵字區別。
(3)'（'向后緊跟，'）'、'，'、';'向前緊跟，緊跟處不留空格。
(4)'，'之后要留空格，如Function(x, y, z)。如果';'不是一行的結束符號，其后要留空格，如for (initialization; condition; update)。
(5)賦值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符，如"="、"+=" ">="、"<="、"+"、"*"、"%"、"&&"、"||"、"<<","^"等二元操作符的前后應當加空格。
(6)一元操作符如"!"、"~"、"++"、"--"、"&"（地址運算符）等前后不加空格。
(7)象"［］"、"."、"->"這類操作符前后不加空格。
(8)對于表達式比較長的for語句和if語句，為了緊湊起見可以適當地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))
示例1-4 代碼行內的空格
void Func1(int x, int y, int z) | void Func1 (int x,int y,int z) |
if (year >= 2000) | if(year>=2000) |
if ((a>=b) && (c<=d)) | < 學習交流
熱門圖片
猜你喜歡的新聞
新聞熱點  2019-10-23 09:17:05
 2019-10-21 09:20:02
 2019-10-21 09:00:12
 2019-09-26 08:57:12
 2019-09-25 08:46:36
 2019-09-25 08:15:43
疑難解答 |
