淺析.NET中文變量及方法的命名規(guī)則
我們將介紹.NET中文變量及方法的命名規(guī)則，相信通過(guò)規(guī)范的.NET中文變量及方法的命名，能令今后的維護(hù)開(kāi)發(fā)工作更加的簡(jiǎn)單，也方便復(fù)用。
目前，我們?cè)陧?xiàng)目中使用.NET中文變量，從3年前的權(quán)限管理，到一年前的購(gòu)物車(chē)管理，發(fā)展到了在類(lèi)庫(kù)（會(huì)員積分獎(jiǎng)金規(guī)則）中使用。體會(huì)到了中文變量對(duì)于項(xiàng)目維護(hù)的巨大方便。現(xiàn)在，我們?cè)诿杜e中基本使用中文。他的意義以及對(duì)我們的好處，在上篇博文中有說(shuō)明，請(qǐng)參考 http://www.cnblogs.com/DotLee/archive/2009/08/19/1549750.html。
前提：開(kāi)發(fā)團(tuán)隊(duì)以中文為主，開(kāi)發(fā)文檔以中文為主，系統(tǒng)的業(yè)務(wù)維護(hù)以中文為主，開(kāi)發(fā)環(huán)境以中文為主。部署環(huán)境無(wú)關(guān)緊要，如果部署環(huán)境是非中文的，要提前在部署環(huán)境中測(cè)試。 建議，***開(kāi)發(fā)與部署環(huán)境相同。以便于提高項(xiàng)目的工作效率。
變量的命名規(guī)則： 如： private float c1_購(gòu)物車(chē)_非換購(gòu)商品總額 = 0; 形式：（英文或拼音）字母前綴+數(shù)字+下劃線+字母前綴的中文名稱(chēng)+下劃線+變量的名稱(chēng)；(英文cart) c1 _購(gòu)物車(chē) _ 非換購(gòu)商品總額 這里： 1表示類(lèi)中的成員變量,建議字母前綴用小寫(xiě)2表示類(lèi)中的方法， 建議字母前綴用大寫(xiě)3表示方法中的局部變量； 建議字母前綴用小寫(xiě)枚舉類(lèi)型的沒(méi)有數(shù)字 如：
- private void C2_購(gòu)物車(chē)()
- {...}
- private void C2_購(gòu)物車(chē)()
- {
- string c3_購(gòu)物車(chē)編號(hào) = WebUtils.GetShoppingCartId();
- }
- public enum OrderStateEnum
- {
- os_訂單狀態(tài)_待處理訂單=1,
- os_訂單狀態(tài)_已付款訂單 = 2,
- os_訂單狀態(tài)_已收款訂單 = 3,
- os_訂單狀態(tài)_已發(fā)貨訂單 = 4,
- os_訂單狀態(tài)_已收貨訂單 = 5,
- os_訂單狀態(tài)_已完成訂單 = 6
- }
- public bool PB2_積分獎(jiǎng)金_加入積分獎(jiǎng)金池(int orderid)
- {
- ...
- bool pb3_積分獎(jiǎng)金_加入積分獎(jiǎng)金池是否成功 = true;
- ...
- pb3_積分獎(jiǎng)金_訂單明細(xì).UO_state = (int)b2cCityBLL.OrderStateEnum.os_訂單狀態(tài)_已完成訂單;
- new b2cCityBLL.OrderBLL().UpdateOrder(pb1_積分獎(jiǎng)金_訂單明細(xì) );
- ...
- return pb3_積分獎(jiǎng)金_加入積分獎(jiǎng)金池是否成功;
- }
這里 pb表示PointsBonus積分獎(jiǎng)金,我們對(duì)前綴的使用絕大多數(shù)使用英文。前綴的字符數(shù)一般不超過(guò)3個(gè)。 因?yàn)樗麄兎植荚诓煌拿臻g里，所以不會(huì)重復(fù)。而且，他們的規(guī)則以簡(jiǎn)單適用為***，來(lái)滿足我們的90%的網(wǎng)站項(xiàng)目。其他的10%,一般而言，不是我們的主要所在。我們的70%的精力，是用在以后項(xiàng)目的維護(hù)上，而不是開(kāi)發(fā)上。也就是以維護(hù)項(xiàng)目為主（70%），開(kāi)發(fā)新項(xiàng)目為輔（30%），這樣，我們的項(xiàng)目功能模塊的復(fù)用率很高，相應(yīng)的開(kāi)發(fā)效率也就提高了。
這樣，通過(guò)前綴可以得到ide的智能提示功能，并且相關(guān)的變量會(huì)排序在一起；中文的名稱(chēng)要與業(yè)務(wù)員進(jìn)行溝通，取得一致意見(jiàn)。
缺點(diǎn)，主要是中文的輸入還存在一定的問(wèn)題，但對(duì)于整個(gè)項(xiàng)目的好處來(lái)說(shuō)，可以忽略。
這是我們3年多開(kāi)發(fā)項(xiàng)目中使用中文變量的經(jīng)驗(yàn)體會(huì)。證明他適用于我們，所以我們?cè)谶@些經(jīng)驗(yàn)的基礎(chǔ)之上，把對(duì)中文變量的使用，逐步的擴(kuò)大范圍。我們的開(kāi)發(fā)流程，主要以msf為主，這對(duì)于我們來(lái)說(shuō)，也是我們目前的***的實(shí)踐吧。
原文標(biāo)題：我們?cè)赿otnet開(kāi)發(fā)里中文變量及方法的命名規(guī)則
鏈接：http://www.cnblogs.com/DotLee/archive/2009/09/19/1570069.html
【編輯推薦】
