提高代碼的可讀性，不僅方便自己以後閱讀，而且可以讓後來的人更好閱讀你的代碼，最近一直在積累這方面的知識，以後嚴格遵循這種寫法，做到“有法可依”，有更好的寫法待用到之時再進行更新補充，在這裡做一下筆記。 1.註釋和文檔 這裡有一個技巧，可以方法的上面連續敲擊三下"/"，就可以自動補充，寫對應的註釋，無 ...
提高代碼的可讀性，不僅方便自己以後閱讀，而且可以讓後來的人更好閱讀你的代碼，最近一直在積累這方面的知識，以後嚴格遵循這種寫法，做到“有法可依”，有更好的寫法待用到之時再進行更新補充，在這裡做一下筆記。
1.註釋和文檔
這裡有一個技巧，可以方法的上面連續敲擊三下"/"，就可以自動補充，寫對應的註釋，無論是js還是C#，在寫代碼之前，都要先進行寫註釋，採用動賓結構，如：“獲取用戶信息”，“添加用戶信息”。陳述方法的做了什麼事，言簡意賅，當然良好的命名規範易讀性更好。
/// <summary>
/// 在這裡寫註釋
/// </summary>
/// <param name="param"></param>
/// <returns></returns>
public ActionResult Index(string param)
{
return View();
}2.代碼分組
為了讓代碼的可讀性更好，可以對代碼進行分組，儘量讓同一邏輯放在同一組，即用換行隔開。
//計算還款金額
var repayMoney = (from h in db.JF_FIN_REPAY
where h.CLIENTID == bpid
&& h.STATE == (int)FinancingEnum.FinRepayState.還款成功
&& h.ORDERTYPE == ((int)FinOrderType.還款單).ToString()
&& h.FINANCETYPE == ((int)FinOrderType.提貨款).ToString()
select h.REPAYTOTALMONEY).Sum();
if (Request["state"] = "已保存")
{
///...
}
if (true)
{
///...
}3.保持一致的命名規範
命名規範，我強制使用駝峰式和帕斯卡命名規範，當然使用其他的也是可以的，沒有問題的，主要習慣便可以，但是必須保持一致，js,C#的代碼的命名規範都要使用駝峰式或帕斯卡命名，C#和js命名有所不同，對應使用即可，如：
js:
//獲取用戶信息
function getUserInfo() {
///...
}C#:
/// <summary>
/// 獲取用戶信息
/// </summary>
public void GetUserInfo()
{
///...
}4.DRY原則（摘錄於阮一峰博客）
DRY是 Don't repeat yourself 的縮寫，意思是"不要重覆自己"。
軟體工程名著《The Pragmatic Programmer》首先提出了這個原則。它的涵義是，系統的每一個功能都應該有唯一的實現。也就是說，如果多次遇到同樣的問題，就應該抽象出一個共同的解決方法，不要重覆開發同樣的功能。
這個原則有時也稱為"一次且僅一次"原則（Once and Only Once）。
如果多次遇到同一問題，就應該將對應的方法進行抽象，進行封裝，便於以後重覆使用，對於一些常用的公共類或者方法可以進行積累，保存於GitHub的項目中等，保存起來便於以後拿取，最近新建了一個項目，對曾經做過的一些公共的、可以抽象封裝的方法等進行積累，避免重覆開發，以後這就是經驗。
5.避免深嵌套
過多的嵌套會極大降低代碼的可讀性：
//獲取用戶信息
function getUserInfo() {
///...
if (true) {
if (true) {
if (true) {
///..
}
}
}
}儘量減少代碼嵌套，不多於兩層：
//獲取用戶信息
function getUserInfo() {
///...
if (true) {
///..
}
if (true) {
///..
}
if (true) {
///...
}
}6.限制行長度
行長度過長也是會極大降低代碼的可讀性：
//計算還款金額
var repayMoney = (from h in db.JF_FIN_REPAY
where h.CLIENTID == bpid && h.STATE == (int)FinancingEnum.FinRepayState.還款成功 && h.ORDERTYPE == ((int)FinOrderType.還款單).ToString() && h.FINANCETYPE == ((int)FinOrderType.提貨款).ToString()
select h.REPAYTOTALMONEY).Sum();可以針對一致的特殊“符號”進行換行，如，“&&”，“||”,“,”等：
//計算還款金額
var repayMoney = (from h in db.JF_FIN_REPAY
where h.CLIENTID == bpid
&& h.STATE == (int)FinancingEnum.FinRepayState.還款成功
&& h.ORDERTYPE == ((int)FinOrderType.還款單).ToString()
&& h.FINANCETYPE == ((int)FinOrderType.提貨款).ToString()
select h.REPAYTOTALMONEY).Sum();7.參數值的命名
對於一些參數的值，有時我們需要對一些數據進行區別，就會使用不同的參數值，進行傳遞，這時候，使用的參數值，如果是一些無意義的值，就會增加代碼的閱讀的難度：
if (Request["state"] = "1")
{
///...
}可以使用一些有意義的名稱保存，中文或者英文，切忌使用一些無意義的數字、字母，使用硬編碼使代碼易讀性更好：
if (Request["state"] = "已保存")
{
///...
}8.避免寫新代碼
在做一個新功能的時候，可以思考，別人是否已經實現這個功能，有沒有工具，函數等已經實現你想要的功能，可以從網上查找或問同事是否已經實現對應的功能，避免盲目重覆造輪子，代碼越少，bug越少。
The best code is the code that isn’t written ”
9.局部變數的命名
這是一個讓我糾結很久的話題，很多人都有不同的命名習慣，也不能說誰的好，誰的不好，把一些固定的用法，按照自己的習慣進行規範：
//Array尾碼的數組變數
Object[] arr = ...;
//使用類型的縮寫
DataTable dt = ...;
//變數的聲明，類型儘量使用介面，這樣對於修改實現容易
IList lst = new ArrayList();
//flag是一個常用的變數
bool flag = false;
//item也是一個常用的命名
foreach (Object item in lst)
{
if (flag)
{
Console.Write(",");
}
flag = true; //flag之前有一個空行，代碼中應有恰當的分行
}
//使用符合短語對變數命名
String name = obj.GetType().GetName(); 參考：
https://www.cnblogs.com/jobs/archive/2004/07/22/26341.html#26355
http://news.51cto.com/art/201708/549819.htm
http://news.51cto.com/art/201710/554067.htm
