C# 命名规范

来源:互联网 发布:qq三国js心法点满 编辑:程序博客网 时间:2024/04/29 11:10

本文从类、类字段、方法属性、参数常量、接口、事件、命名空间等9个方面总结了C#语言命名的规则。 
下面介绍C#语言命名的9种规范: 

a)类 

【规则1-1】使用Pascal规则命名类名,即首字母要大写。 

【规则1-2】使用能够反映类功能的名词或名词短语命名类。 

【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。 

【规则1-4】自定义异常类应以Exception结尾。 

【规则1-5】文件名要能反映类的内容,最好是和类同名。 

b) 类字段 

【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。 

【规则2-2】类字段变量名前可加“_”前缀。 

【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。 

c)方法 

【规则3-1】方法名采用Pascal规则,第一个字符要大写。 

【规则3-2】方法名应使用动词或动词短语。 

【规则3-3】类中访问修饰符或功能相同的方法应该放在一起, 且公共或实现接口的方法在前。 

d)属性 

【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写。 

【规则4-2】属性和相应字段名称要关联,可以使用“重构”菜单来生成属性。 

e)参数 

【规则5-1】参数采用camel规则命名,且首字符小写。 

【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。 

【规则5-3】不要给参数加匈牙利语类型表示法的前缀。 

【规则5-4】检查方法所有输入参数的有效性。 

f)常量 

【规则6-1】只读常量使用Pascal命名规则,即首字母大写。 

【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。 

【规则6-3】枚举值从小到大顺序定义。 

【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。 

g)接口 

【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。 

【规则7-2】接口名称要有意义,中间不要有下划线“_”等字符。 

【规则7-3】如果类实现了接口,名称尽量和接口相同,只是省掉“I”字符。 

h)事件 

【规则8-1】委托名称采用Pascal规则,即首字符大写。 

【规则8-2】定义事件的委托要使用EventHandler后缀,且包括sender和e两个参数。 

【规则8-3】事件用到的参数类,名称要带EventArgs后缀。 

i)   C#语言命名空间 

【规则9-1】命名空间名称采用Pascal规则,且首字符大写。 

【规则9-2】命名空间名称尽量反映其内容所提供的整体功能。 

总结: 
命名空间,类,事件,接口,常量,属性,方法使用Pascal命名,即首字母大写 
参数,变量(类字段)使用camel命名法,即首字母小写

 

大家都知道写程序应该有个好的命名规范,为了工作方便,贴出来。
1 ADO.NET 命名规范

数据类型 数据类型简写 标准命名举例 ConnectionconconNorthwindCommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdstdstNorthWindDataTabledtbldtblProductDataRowdrowdrowRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts

2 WinForm Control 命名规范

数据类型 数据类型简写 标准命名举例 LabellbllblMessageLinkLabelllblllblTodayButtonbtnbtnSaveTextBoxtxttxtNameMainMenummnummnuFileCheckBoxchkchkStockRadioButtonrbtnrbtnSelectedGroupBoxgbxgbxMainPictureBoxpicpicImagePanelpnlpnlBodyDataGriddgrddgrdViewListBoxlstlstProductsCheckedListBoxclstclstCheckedComboBoxcbocboMenuListViewlvwlvwBrowserTreeViewtvwtvwTypeTabControltctltctlSelectedDateTimePickerdtpdtpStartDateHscrollBarhsbhsbImageVscrollBarvsbvsbImageTimertmrtmrCountImageListilstilstImageToolBartlbtlbManageStatusBarstbstbFootPrintOpenFileDialogodlgodlgFileSaveFileDialogsdlgsdlgSaveFoldBrowserDialogfbdlgfgdlgBrowserFontDialogfdlgfdlgFootColorDialogcdlgcdlgColorPrintDialogpdlgpdlgPrint

3 WebControl 命名规范

数据类型 数据类型简写 标准命名举例 AdRotator adrt Example Button btn btnSubmit Calendar cal calMettingDates CheckBox chk chkBlue CheckBoxList chkl chklFavColors CompareValidator valc valcValidAge CustomValidator valx valxDBCheck DataGrid dgrd dgrdTitles DataList dlst dlstTitles DropDownList drop dropCountries HyperLink lnk lnkDetails Image img imgAuntBetty ImageButton ibtn ibtnSubmit Label lbl lblResults LinkButton lbtn lbtnSubmit ListBox lst lstCountries Panel pnl pnlForm2 PlaceHolder plh plhFormContents RadioButton rad radFemale RadioButtonList radl radlGender RangeValidator valg valgAge RegularExpressionvale valeEmail_ValidatorRepeater rpt rptQueryResults RequiredFieldValidatorvalr valrFirstName Table tbl tblCountryCodes TableCell tblc tblcGermany TableRow tblr tblrCountry TextBox txt txtFirstName ValidationSummaryvals valsFormErrors XML xmlc xmlcTransformResults

0 0
原创粉丝点击