2) 文件功能描述只需簡述,具體詳情在類的注釋中描述。
3) 創建標識和修改標識由創建或修改人員的拼音或英文名加日期組成。如:
姚明20040408
4) 一天內有多個修改的只需做一個在注釋說明中做一個修改標識就夠了。
5) 在所有的代碼修改處加上修改標識的注釋。
2 代碼外觀
2.1 列寬
代碼列寬控制在110字符左右,原則上不超過屏寬。
2.2 換行
當表達式超出或即將超出規定的列寬,遵循以下規則進行換行:
1、在逗號,括號後換行。
2、在操作符前換行。
3、規則1優先於規則2。
當以上規則會導致代碼混亂的時候自己采取更靈活的換行規則。
2.3 縮進
縮進應該是每行一個Tab(4個空格) ,不要在代碼中使用Tab字符。
Visual Studio.Net設置:工具->選項->文本編輯器->C#->制表符->插入空格
2.4 空行
空行是為了將邏輯上相關聯的代碼分塊,以便提高代碼的可閱讀性。
在以下情況下使用兩個空行:
1、接口和類的定義之間。
2、枚舉和類的定義之間。
3、類與類的定義之間。
在以下情況下使用一個空行:
1、方法與方法、屬性與屬性之間。
2、方法中變量聲明與語句之間。
3、方法與方法之間。
4、方法中不同的邏輯塊之間。
5、方法中的返回語句與其他的語句之間。
6、屬性與方法、屬性與字段、方法與字段之間。
7、注釋與它注釋的語句間不空行,但與其他的語句間空一行。
8、文件之中不得存在無規則的空行,比如說連續十個空行。空行是為了將邏輯上相關聯的代碼分塊,以便提高代碼的可閱讀性。