1.編碼規范對於程序員而言尤為重要,有以下幾個原因：
1.1.一個項目的生命周期中,80%的花費在於維護;
1.2.幾乎沒有任何一個項目,在其整個生命周期中,均由最初的開發人員來維護;
1.3.命名規范可以改善項目的可讀性,可以讓程序員盡快而徹底地理解新的代碼;
1.4.如果你將源碼作為產品發布,就需要確任它是否被很好的打包並且清晰無誤,比如你已構建的其它任何產 品。 為了執行規范,每個軟件開發人員必須一致遵守編碼規范。
2.命名原則：
2.1.使名稱足夠長以便有一定的意義,並且足夠短以避免冗長;
2.2.唯一名稱在編程上僅用於將各項區分開;
2.3.表現力強的名稱是為了幫助人們閱讀。
3.sql文件命名規范：
3.1.命名順序：
1.開頭注釋 2.文件名 3.創建人 4.日期 5.描述 6.版本
3.2.例:
//********************************************//
//**文件名:sp_CalcTask.sql
//**創建人:張三
//**日期:2017/08/13
//**描述:主要完成數據庫自動計算任務
//**版本:1.4版本
//********************************************//
create proc sp_CalcTask(
@p_Time int ,//時間周期
@p_AutoCalc bit //是否自動運算
) begin //TODO end
4.cs文件格式：
4.1.命名順序：
1.開頭注釋 2.文件名 3.創建人 4.日期 5.描述 6.版本
4.2.例:
//********************************************//
//**文件名:RandomCreator.cs
//**創建人:張三
//**日期:2017/08/13
//**描述:主要完成隨機數字的生成
//**版本:1.4版本
//********************************************//
usingSystem;
usingSystem.Collections.Generic;
usingSystem.Text; namespace COMM
{
public class RandomCreator
{
//TODO...
}
}
5.后端API標准格式：
5.1.命名順序：
1.開頭注釋 2.文件名 3.創建人 4.日期 5.描述 6.版本
5.2.例:
/// <summary>
/// 服務調用處理函數
/// </summary>
/// <param name="userId">用戶Id</param>
/// <param name="userName">用戶姓名</param>
/// <returans>返回.. </returns>
///
public string UpdateUserInfo(string userId,string userName)
{
//TODO...
}