資源描述：
《c#軟件開發(fā)編碼規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。
1、類書寫標(biāo)準(zhǔn)(C#/VB.NET)Ver:1.1頂部聲明內(nèi)容2方法位置3#Region使用5變量初始值6變量命名7頂部聲明內(nèi)容文件的頂部可以包含文件的測(cè)試數(shù)據(jù)、注釋、作者、創(chuàng)建時(shí)間、修改人、修改時(shí)間。但不強(qiáng)行規(guī)定。但涉及到數(shù)據(jù)的，需要包含測(cè)試數(shù)據(jù)。注釋以//的方式添加多個(gè)單行注釋。//作者：吳亞喆(wyz)//創(chuàng)建時(shí)間：2008-8-14//修改人：吳亞喆//修改時(shí)間：2008-8-15//功能：消息管理器方法位置方法需要將相關(guān)的內(nèi)容歸類在一起。我們分為下面幾個(gè)部分：1.delegateandsubtype2.field3.prop
2、erty4.ctor,init,dtor5.method6.function這里6個(gè)部分表示了一個(gè)類最復(fù)雜情況所包含的內(nèi)容。把相關(guān)內(nèi)容放在一起也利于我們自己查找和維護(hù)。下面介紹一下每個(gè)部分應(yīng)該書寫什么內(nèi)容。delegateandsubtype類中用到的委托，或者子類型的聲明，子類型不要聲明為平級(jí)，而是聲明為包含的類。field成員變量，盡量的都聲明為私有，事件聲明為其他訪問(wèn)級(jí)別。property屬性書寫在這里，屬性的訪問(wèn)器get和set的訪問(wèn)級(jí)別可以不一樣，例如publicintIntProperty{publicget{retu
3、rnintVar;}internalset{intVar=value;}}cotor,init,dtor構(gòu)造函數(shù)，初始化和釋放。如果是窗體，對(duì)應(yīng)的OnLoad,OnHandleCreate,OnActive的方法，F(xiàn)orm1_Load,Form1_Active的事件響應(yīng)方法應(yīng)當(dāng)卸載這里。如果是控件，對(duì)應(yīng)的OnLoad,OnHandleCreate,OnActive,OnParentChanged的方法應(yīng)當(dāng)寫在這里。如果是一般的類，Dispose接口的實(shí)現(xiàn)，析構(gòu)函數(shù)，釋放函數(shù)都應(yīng)當(dāng)寫在這里。method書寫類對(duì)外的主要接口方法，例如
4、Open,Close,Write,Read之類，對(duì)象直接的抽象。function書寫可能重復(fù)的方法，例如多個(gè)Open方法都要做CheckOpenStatus，這個(gè)操作用戶不會(huì)直接使用，或者不常用，則寫在這里。模板類：/*注意事項(xiàng)：*/usingSystem;usingSystem.Collections.Generic;usingSystem.Text;namespaceZHD{publicclassClass1{#regiondelegateandsubtype#endregion#regionfield#endregion#r
5、egionctor,init,dtorpublicClass1(){}#endregion#regionproperty#endregion#regionmethod#endregion#regionfunction#endregion}}#Region使用Region表示相關(guān)的內(nèi)容，避免分類過(guò)細(xì)，請(qǐng)按照前一部分列出的進(jìn)行分類。函數(shù)內(nèi)部或者類的內(nèi)部，可以嵌套region使用。盡可能的使用此標(biāo)簽折疊相關(guān)內(nèi)容。折疊的好處是我們可能打開某個(gè)部分。先看到每個(gè)region，對(duì)程序有個(gè)認(rèn)識(shí)，然后根據(jù)需要展開具體的塊。如果需要全部展開，可以使用
6、快捷鍵：ctrl+m,ctrl+o。變量初始值變量分2種，類成員變量和方法的局部變量。成員變量：盡可能的在聲明處初始化，但不要進(jìn)行多余的初始化，例如對(duì)數(shù)值類型變量賦值為0，對(duì)引用類型變量賦值為null。這樣會(huì)多一條IL的匯編語(yǔ)句，并不會(huì)帶來(lái)實(shí)際意義。對(duì)于需要在運(yùn)行時(shí)構(gòu)造的，編寫構(gòu)造函數(shù)，并在多個(gè)構(gòu)造函數(shù)的情況下，通過(guò)調(diào)用來(lái)初始化，不要賦值代碼。局部變量：主動(dòng)釋放自己分配的非托管資源。變量命名類型的縮寫+功能，例如，創(chuàng)建一個(gè)窗體，就起名為：frmRoad。frm為前綴，form的縮寫，Road是功能，第一個(gè)字母小寫，好處是frm小寫
7、，人們注意力首先會(huì)看到大寫字母，能看到功能描述的單詞，然后才關(guān)注frm。突出重點(diǎn)。也能從變量名知道是什么類型的。類名的命名：1．窗體?？丶悾枰谇懊鎸戭愋?，例如：frmRoad,ctlSurveyComputer。2．功能形類，無(wú)特殊要求，除非行業(yè)有縮寫的拼音，否則禁止使用拼音命名。3．窗體內(nèi)，盡量不使用默認(rèn)的名稱，除非窗體非常簡(jiǎn)單。只有2個(gè)按鈕，分別是OK,Cancel，不用編寫任何實(shí)現(xiàn)或者不用引用。則可以使用默認(rèn)名稱，只修改DialogResult部分。Label，如果不需要修改，也可以不重命名使用系統(tǒng)的默認(rèn)名稱。如果反復(fù)
8、使用的，不能出現(xiàn)MenuItem1....MenuItemn或者ComboBox1,Button1之類的?？梢允褂每s寫，例如：MenuItemConnect避免寫的太長(zhǎng)，可以縮寫為：menuConnect或者miConnect，buttonTest
