代 碼 設 計 規(guī) 范
一、注釋規(guī)范
1、自建代碼文件注釋
對于自己創(chuàng)建的代碼文件（如函數(shù)、腳本），在文件開頭，一般編寫如下注釋：
/*************************************************
作者：
說明：
創(chuàng)建日期：
版本號：
**********************************************/
2、標準注釋
在模塊、類、屬性、方法前一行添加注釋，以便調用的時候提示用戶，下以方法聲明做例子：
///<summary>
///<對該方法的說明>
///</summary>
///<paramname="<參數(shù)名稱>"><參數(shù)說明></param>
///<returns>
///<對方法返回值的說明，該說明必須明確說明返回的值代表什么含義>
///</returns>
3、代碼中的注釋
代碼間注釋分為單行注釋和多行注釋：
單行注釋：
//<單行注釋>
多行注釋：
/*多行注釋1
多行注釋2
多行注釋3*/
代碼中遇到語句塊時必須添加注釋（if,for,foreach,……）,添加的注釋必須能夠說明此語句塊的作用和實現(xiàn)手段（所用算法、循環(huán)條件、不同分支的意義等等）。
二、異常處理
1、數(shù)據(jù)層及服務層異常必須要記錄到服務日志中
try
{ }
catch (DbEntityValidationException ex)
{ throw new SerivceException ("");}
catch (SerivceException ex)
{throw ex; }
catch (Exception ex)
{throw new SerivceException (""); }
2、業(yè)務層及客戶端異常要記錄在文件中
原則異常msg描述清楚所發(fā)生錯誤原因、關鍵必要的參數(shù)，已便于客戶端使用者、測試人員及相關研發(fā)人員明白錯誤原由。
三、Web頁面
1、出現(xiàn)超出半屏幕的html標簽時需要加注釋 例：<!-- BEGIN 描述 --> <body></body> <!-- End 描述 -->
2、Js命名規(guī)則
函數(shù): fn 例： fnMethod
事件: on例： eventBeforeSave
3、單行的 IF - ELSE，WHILE 或者 FOR 語句也 必須 加入括號，不過他們可以這樣寫：
if (condition){ statement; }
while (condition){ statement; }
for (intialization; condition; update){ statement; }
4、
foreach(var item in list){
foreach(var item1 in list){
foreach(var item2 in list){
}
}
}
三、命名規(guī)范
1、程序集命名、命名空間、類(全部為中文名)
1）程序集：項目域名+項目名稱+模塊名 例：六月版.供應商.業(yè)務層
2）命名空間：六月版.供應商.業(yè)務層.單據(jù)管理 （業(yè)務邏輯后綴'管理'）
3）類名：訂單
2、方法命名
1）業(yè)務層、服務方法命名
以混合命名法為主，常用動詞單詞+中文詞描述+'_'+精確描述
Get*** //'獲取***'
Create*** //'創(chuàng)建***'
Update*** //'更新***'
Del*** //'刪除***'
Save*** //'創(chuàng)建或修改***'
Fill*** //'填充***'多用于業(yè)務邏輯處理
Add*** //'添加***' 多用于業(yè)務邏輯處理
Remove***//'移除***' 多用于業(yè)務邏輯處理
例：public VM.訂單 Get訂單信息(string 訂單編號)
public void Update訂單狀態(tài)_已出庫(string 訂單編號, string 操作人)
對于獲取多條記錄的方法名要加以 '集'結尾
例：public List<VM.訂單> Get訂單信息集(string 關鍵字)
3） 方法參數(shù)全部為中文名，Mvc Controllers方法參數(shù)（全英文）//開頭字母小寫
4)MVC 分布視圖 _開頭加開頭大寫單詞
3、變量命名
命名空間引用縮寫
業(yè)務層： 例：using BS供應商=六月版.供應商.業(yè)務層 ；
數(shù)據(jù)層： 例：using DAO供應商=六月版.供應商.數(shù)據(jù)層 ；
服務層： 例：using Server供應商=六月版.供應商.服務 ；
視圖模型： 例：using VM供應商=六月版.供應商. 視圖模型
公共類庫： 例：using Comm=DotNet.Common；
變量命名以混合命名法為主
Sbyte: sbte | Char: chr |
Short: sht | Object: obj |
Int: int | String: str |
Long: lng | DateTime: dte |
Byte: bte | IntPtr: intptr |
Ushot: usht | 臨時變量: tmp |
Uint: uint | Guid: g |
Ulong: ulng | （s、dao）實體模型: model |
|
學習交流
熱門圖片
猜你喜歡的新聞
新聞熱點  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
疑難解答 |
