CSharp編碼定名規(guī)矩

1、C#編碼命名規(guī)則1. 基本規(guī)則第一個字母必須大寫，并且后面的并發(fā)連結詞的第一個字母均為大寫例：GeneralManager、SmallDictionary、StringUtil2. 接口命名規(guī)則接口名稱前加“i”interfaceICompareintcompare。；類的命名類名添加cls前綴publicclassclsTextBoxpublicvoidDataBind()Webserver的命名類名添加ws前綴publicclasswsTextBoxpublicvoidDataBind()方法、屬性的命名使用Pascal大小寫形式，一般將其命名為動賓短語ShowDialog()Create

2、File()變量、參數(shù)使用Camel大小寫形式例：inttotalCount常量全部大寫，單詞之間以“_”分隔例：USER_PASSWORD代碼的縮進用Tab，而不要用space其他代碼命名規(guī)則1. 局部變量的名稱要有意義不要用x,y,z等等（循環(huán)變量除外）2. 所有的成員變量聲明在類的頂端，用一個換行把它和方法分開3. 文件名要能反應類的內(nèi)容，最好是和類同名，一個文件中一個類4. 大括號要新起一行.publicclassAuthorAttribute:Attribute5. switch語句一定要有default來處理意外情況6. 同程序外部連接（數(shù)據(jù)庫、接口、文件等）一定要捕獲任何類型的異

3、常（try）給出友好的消息給用戶，必要時用日志記錄錯誤的細節(jié)，包括發(fā)生的時間，和相關方法,類名等。不要捕捉了異常卻什么也不做”7. 始終使用包含if/else下的語句，即使只有一條語句8. 把引用的系統(tǒng)的namespace和自定義或第三方的分開9. 自定義的屬性以Attribute結尾publicclassAuthorAttribute:Attribute10. 自定義的異常以Exception結尾publicclassAppException:Exception11. 注釋需和代碼對齊12. 用一個空行來分開代碼的邏輯分組13. 花括?。ǎ┬韬屠ㄌ柾獾拇a對齊14. 不在代碼中使用具體的路徑

4、和驅動器名，使用相對路徑，并使路徑可編程數(shù)據(jù)庫命名規(guī)則15. 表：e業(yè)務表中相對獨立的實體表（例如：課程資源表）r業(yè)務中產(chǎn)生的關聯(lián)表（例如：選課表）b系統(tǒng)中的基本表（例如：類型表、民族、地區(qū)）16. 視圖：v_首字母大寫17. 存儲過程：sp_首字母大寫18. 觸發(fā)器：t_首字母大寫19. 函數(shù)過程：fn_首字母大寫20. 列名：如英文過長（超過6位）或過于生僻可用漢語拼一般第一列名為ID、主鍵、標識遞增其他列名盡可能用英文單詞或英文縮寫,音的首字母。控件命名：ControltypeprefixExampleButtonbtnbtnOKGridgrdgrdPrices3DPanelpnlpnl

5、GroupADODataadoadoBiblioAnimatedbuttonanianiMailBoxCheckboxchkchkReadOnlyComboboxcbocboEnglishDropdownlistboxddlddlUserCommandbuttoncmdcmdExitCommondialogdlgdlgFileOpenCommunicationscomcomFaxControl(usedwithinprocedureswhenthespecifictypeisunknown)ctrctrCurrentDatadatdatBiblioData-boundcomboboxdbcbo

6、dbcboLanguageData-boundgriddbgrddbgrdQueryResultData-boundlistboxdblstdblstJobTypeDatacombodbcdbcAuthorDatagriddgddgdTitlesDatalistdbldblPublisherDatarepeaterdrpdrpLocationDatepickerdtpdtpPublishedDirectorylistboxdirdirSourceDrivelistboxdrvdrvTargetFilelistboxfilfilSourceFlatscrollbarfsbfsbMoveFormf

7、rmfrmEntryFramefrafraLanguageGaugegaugauStatusGraphgragraRevenueHierarchicalflexgridflexflexOrdersHorizontaiscrollbarhsbhsbVolumeImageimgimgIconImagecomboimgcboimgcboProductImageListilsilsAllIconsLabellbllblHelpMessageLightweightcheckboxlwchklwchkArchiveLightweightcomboboxlwcbolwcboGermanLightweight

8、commandbuttonlwcmdlwcmdRemoveLightweightframelwfralwfraSaveOptionsLightweighthorizontalscrollbarlwhsblwhsbVolumeLightweightlistboxlwlstlwlstCostCentersLightweightoptionbuttonlwoptlwoptIncomeLevelLightweighttextboxlwtxtlwoptStreetLightweightverticalscrollbarlwvsblwvsbYearLinelinlinVerticalListboxlstl

9、stPolicyCodesListViewlvwlvwHeadingsMAPImessagempmmpmSentMessageMAPIsessionmpsmpsSessionMCImcimciVideoMenumnumnuFileOpenMonthviewmvwmvwPeriodMSChartchchSalesbyRegionMSFlexgridmsgmsgClientsMSTabmstmstFirstOLEcontaineroleoleWorksheetOptionbuttonoptoptGenderPictureboxpicpicVGAPictureclipclpclpToolbarPro

10、gressBarprgprgLoadFileRemoteDatardrdTitlesRichTextBoxrtfrtfReportShapeshpshpCircleSlidersldsldScaleSpinspnspnPagesStatusBarstastaDateTimeSysInfosyssysMonitorTabStriptabtabOptionsTextboxtxttxtLastNameTimertmrtmrAlarmToolbarTreeViewtlbtlbActionstretreOrganizationUpDownupdupdDirectionVerticalscrollbarv

11、sbvsbRate注記Pascal大小寫形式所有單詞第一個字母大寫，其他字母小寫。Camel大小寫形式一一除了第一個單詞，所有單詞第一個字母大寫，其他字母小寫。c#編碼規(guī)則舉例C#編碼規(guī)則規(guī)則約定例子（說明）用pascal規(guī)則來命名方法和類型publicclassMyClasspublicvoidDataBind();用camel規(guī)則來命名局部變量和方法的參數(shù)publicvoidAddUser(stringuserId)stringuserName;所有的類成員變量前加前綴_”對外公開名稱用pascal規(guī)則命名privateclassMyClassprivatestring_userName;

12、publicstringUserNamegetset接口的名稱加前綴I”InterfaceICompare枚舉的命名是Pascal命名publicenumProductType常量命名全部大寫，單詞間以下劃線間隔publicconstintLOCKSECONDS=3000;自定義的屬性以Attribute結尾publicclassAuthorAttribute:Attribute自定義的異常以Exception結尾publicclassMyException:Exception方法的命名一般將其命名為動賓短語ShowDialog()用有意義的名子命名namespace口：產(chǎn)品名、公司名。函數(shù)、

13、屬性、類等注釋請使用/”三斜線注釋這種注釋是基于XML的，不僅能導岀XML制作幫助文檔，而且在各個函數(shù)、屬性、類等的使用中，編輯環(huán)境會自動帶岀注釋，方便你的開發(fā)。以protected，protectedInternal,public聲明的疋義注釋請都以這樣命名方法。文件頭部注釋標注岀創(chuàng)始人、創(chuàng)始時間、修改人、修改時間、代碼的功能這在團隊開發(fā)中必不可少，它們可以使后來維護/修改的同伴在遇到問題時，在第一時間知道他應該向誰去尋求幫助，并且知道這個文件經(jīng)歷了多少次迭代、經(jīng)歷了多少個程序員的手。使用空格1:雙目操作符的前后加空格2:單目操作符前加空格3:逗號、分號只在后面加空格使用空行在一段功能代碼、或者函數(shù)、屬性之間插入空行，這樣會很直觀。類的成員數(shù)據(jù)/方法調用時，應該加上this限定符this在編輯環(huán)境中是藍色的，更利于我們區(qū)分局部變量、參數(shù)或靜態(tài)變量，并且利于FXCop檢測區(qū)分。命名縮寫不要使用縮寫命名我們從來不害怕長的變量命名，而卻擔心看不懂的命名。好的命名不需要注釋。文字常量和數(shù)字常量不要硬編碼，應該用常量類或枚舉代替