.NET命名规范

合集下载

net命名规范的不同

net命名规范的不同在你的代码中使用注释语句和下边就要讲的统一命名法则是一个很好的习惯，它们会使你的代码更加通用。

我(作者)已经在微软工作了近五年的时间了。

我不知道你是否跟我一样，在集成和除BUG时遇到很多问题----因为开发者没有遵守统一的命名法则和写注释语句。

在以前版本的Visual Studio中，微软曾建议使用匈牙利命名法来写代码，并鼓励开发这位写出统一格式的代码而使用相同的法则。

例如：变量命名CStringSzStringcharCmyCharchar*PmyCharLongLMyVariableLPCSTRLpStrIntNMyNumber在最近发布的.net和它的编程语言中，微软更换了他的这一法则。

如果你用过Delphi编程，你会看到新的法则与Delphi(Pascal)有些相似。

为避免代码冲突（这样做也会让你的代码更为通用），就要使用命名法则，这是一个很好的编程习惯。

好啦，这里介绍一些常用的法则。

◆命名变量、方法、以及属性变量、方法和属性的名称的第一个字母应该大写，并且名称应该能表达出它们的用途（或者说是意义）。

变量.NET 命名匈牙利命名描述CstringEmployeeNameszNameName of an employee.IntAttendanceCounternCounterA counter of type long.LongNumberOfByteslBytesA long type variable stores bytes.有时我们习惯于在定义中使用下划线"_"，例如：Add_Data(int a, int b). 按照新的命名法则，这不是一个好的编程习惯，虽然它并没有错。

你应该将定义Add_Data 改为AddData。

这不是微软的标准，你也不是必须按照这些法则。

但是，在一些地方你会明白下边这些法则的合理性。

就我个人而言，我更喜欢匈牙利命名法。

项目的代码命名规范

基于.NET项目的代码书写规范要求书第一章主体命名规范外挂服务命名规范服务项目命名所有服务项目名使用ESrv（注意大小写）开头，第五位字母开始自订义，但是第五位字母必须大写。

比如ESrvDemo1，其中Demo1为自定义名称。

二、类成员访问权限规范所有类成员要严格的按照成员的使用性质，设置它们的访问修饰符，修饰符的意义如下：声明的可访问性意义l public //访问不l 受限制。

l protected //访问仅限于包含类或从包含类派生的类型。

l internal //访问仅限于当前程序集。

l protected internal //访问仅限于从包含类派生的当前程序集或类型。

l private //访问仅限于包含类型。

第二章代码书写规范一、代码注释规范1) .cs文件的注释所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等格式如下://********************************************************////创建日期: 2004.7.19//作者: XXX//功能说明:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX////********************************************************函数参数命名及过程注释参数一定要能说明要传递的意思，用对应的英文或相近的英文单词表示均小写开头。

所有的函数体开头都要加上注释，所以注释使用.NET注释规范，如下格式：/// <summary>/// 构造函数/// </summary>/// <param name="netPath">示例参数1</param>/// <param name="myPath">示例参数2</param>public UpgradeThread(string netPath, string myPath){程序语句。

理解.net命名规则和命名习惯

理解.net命名规则和命名习惯　下面小编给大家分享的是理解命名规则和命名习惯，在这里详细的介绍了理解命名规则和命名习惯，希望对大家有所帮助. 想用.NET进行网站建设或程序开发，没有好命名规则和命名习惯，是不行的。

下面我们就了解一下的命名规范！命名规则就是给变量取名的一种规则，一般来说，命名规则就是为了让开发人员给变量或者命名空间取个好名，不仅要好记，还要说明一些特性。

在C#里面，有常用的一些命名的习惯如下。

qPascal大小写形式：所有单词的第一个字母大写，其他字母小写。

qCamel大小写形式：除了第一个单词，所有单词的第一个字母大写，其他字母小写。

当然，在其他编程中，不同的开发人员可能遇到了一些不一样的命名规则和命名习惯，但是在C#中，推荐使用常用的一些命名习惯，这样能保证代码的优雅性和可读性。

同时，也应该避免使用相同名称的命名空间或与系统命名相同的变量，如以下代码所示： string int;//系统会提示出错运行上述代码时系统会提示错误，因为字符串“int”是一个关键字，当使用关键字做变量名时，编译器会混淆该变量是变量还是关键字，所以系统会提示错误。

所以，在变量声明时应该避免变量名称与关键字重名，如果变量名称与关键字重名，编译器就会报错，C#中常用的关键字如表2-2所示：表2-2 不应使用的关键字名称 AddHandlerAddressOfAliasAndAnsiAs AssemblyAutoBitAndBitNotBitOrBitXor BooleanByRefByteByValCallCase CatchCBoolCByteCCharCDateCDec CDblCharCIntClassCLngCObj ConstCShortCSngCStrCTypeDate DecimalDeclareDefaultDelegateDimDo DoubleEachElseElseIfEndEnum EraseErrorEventExitExternalSourceFalse 。

编码命名规范(.NET)(很全很实用)

using net91com.Movies.DataAccess; using net91com.Movies.Business; using monComponent;
三、代码注释 1.注释的目的
a. 文字说明代码的作用 (即为什么要用编写该代码，而不是如何编写); b. 确指出该代码的编写思路和逻辑方法 ; c. 人们注意到代码中的重要转折点 ; d. 使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法
8.增强注释的可读性 a. 使用完整的语句。 b. 避免使用缩写。 c. 将整个单词大写，以突出它们的重要性。
9.请在每个 if 语句/switch 语句/循环语句的前面加上注释
四、类/接口成员设计 1.设计类和方法时的原则
创建更加容易调试和维护的方法创建具有强大内聚力的类创建高度专用的方法创建松散连接的方法尽量使方法具有独立性提高方法的扇入性降低方法的扇出性 2.名称空间引用 using 声明一律以.NET 基础框架命名空间、第三方组件命名空间、最后是公司内部产品命名空间排序。 using System; using System.Collections; using Microsoft.CSharp; using Sirc.Egss.FileExchangeServer; 3.成员排列规则尽量不要使用类 public 变量，用属性代替类成员以 internal、private、protected、public 排列。public 部分按照构造函数、属性、方法、事件的顺序排列。 4.每个类文件名应尽量保持与内部类名一致 5.尽量避免手动去修改工具环境自动生成的代码 6.避免在一个类文件里放置多个类 7.一个类文件里应该有且仅有一个命名空间，避免在一个类文件里包含多个不同的命名空间 8.避免在一个类文件里代码超过 500 行（除去自动生成的代码） 9.数据结构里，应该总是更倾向使用 C#的范型 generic 10.尽量缩小变量的作用域 11.接口设计将接口名去掉 I 前缀后，作为这种默认实现类的名称。比如 IComponent 的默认实现类是 Component 每个接口不应当有超过 20 个成员的情况，一般应保持在 12 个左右 12.方法设计创建松散连接和高度专用的方法创建方法时，设法将每个方法视为一个黑箱，其他例程不应要求了解该方法的内部工作情况，该方法也不应要求了解它外面的工程情况。这就是为什么你的方法应依靠参数而不应依靠全局变量的原因。 a.将复杂进程放入专用方法。 b.将专用方法中可能要修改的代码隔离。 c.将数据输入/输出（I/O）放入专用方法。 d.将业务规则封装在专用方法中。 e.有返回值的方法必须在方法命名里包含对该返回值的信息描述，如 GetObjectStat()。 f.局部变量的声明，应尽可能紧靠在它首次被使用的地方 g.一个方法里的代码避免超过 25 行，最多不能超过 50 行（除去空行、注释） h.一行代码最多不要超过 80 个字符 i.避免使用强制转换，推荐使用 as 操作符进行防御性转换 j.当需要创建一个长字符串时，推荐使用 StringBuilder，而非 string

.net core mysql 命名规则

.net core mysql 命名规则.NET Core MySQL 是一种常用的数据库管理系统，它可以通过.NET Core 框架快速构建跨平台应用，并对数据进行良好的管理和操作。

比如，用户注册、登录、数据检索等功能都需要涉及到数据库。

因此，在开发应用时，必须遵循一定的命名规则，以确保数据表的合理性和一致性，同时也方便开发者理解和维护代码，提高代码的可读性和可维护性。

一、表命名规则首先，表名必须能够清晰地描述其所保存的数据类型。

为了方便与其他数据表进行区分，建议采用以下命名规则：1.表名统一使用小写字母，单词间使用下划线分隔，例如：user_info。

3.不要使用 MySQL 中的保留字即数据类型作为表名。

二、列命名规则其次，列名应该清晰地描述该列所保存的数据。

此外，不同的列应该采用不同的命名规则，以规避混淆。

2.注意列名不应该过长，通常不超过30个字符。

3.列名应该是名词，而非动词。

例如，避免使用 is_valid，可以使用 valid。

4.尽量避免使用数字，例如将列名设置成 birthday 和 birthday_date，而不是birthday1和birthday2。

例如，user_id，user_name，user_age，user_gender等都是良好的列命名规则。

三、主键命名规则主键是一种特殊的列，通常用于唯一标识数据表中的每个记录。

因此，主键的命名规则非常重要，以确保主键的唯一性和易于区分。

1.主键建议采用表名+id的命名方式，例如：user_id，order_id等。

3.如果主键是自动生成的，可以使用一个统一的命名规则，例如：id。

四、外键命名规则外键是与其他表内具有关联的字段，用于提供跨表查询的功能。

因此，外键的命名规则应该与主键相对应，既不混淆，又不重复。

3.外键列的值应该与其关联表的主键列的值相同，确保外键关系的可靠性。

五、其它命名规则除了数据表、列、主键和外键的命名规则之外，还有一些其它的规则需要遵循，如下：1.命名需避免使用特殊字符，例如：$, %, ^, @等。

.Net项目命名规范

.Net项⽬命名规范⽬录dotShare系统改造项⽬的建设过程中，将涉及到Visual 、Web站点，业务对象及数据库，同时项⽬⼈员包括设计⼈员、开发⼈员和测试⼈员等较多。

为了保持应⽤程序、组件、⽂件的⼀致性，便于阅读和管理代码和结构，提⾼开发效率和产品的标准化，特制订⼀套开发规范和标准（包括命名规范和编码规范）。

好的编码约定可使源代码严谨、可读性强且语意清楚，做到与其它语⾔约定相⼀致，并且提⾼直观性。

希望设计/开发⼈员严格遵守此套开发规范和标准，并落实到⾃⼰的设计与代码程序中。

命名规范将包括：编程命名规范，业务对象命名规范，数据库命名规范，Web站点结构命名规范等。

编码规范将包括：C#编码规范，第三⽅模块使⽤规范等本命名规范主要针对使⽤Visual （语⾔及C#语⾔）规范，即编程命名规范部分。

请注意：在本项⽬过程中，C#将作为⾸选语⾔，如⾮特别必要，不要选⽤。

变量命名的总原则是⼀个通⽤性的原则，本规范后续章节中的命名规则都应当符合这些总原则。

·变量名称应当准确完整地描述了变量的含义·名称应当反映了业务上的问题⽽不是技术上或编程上的解决⽅法·名称的长度应当⾜够长·名称的最后⼀部分应当有限定符·应当⽤Count, Index或Nbr代替Num, No.·循环计数变量的的名称应当有含义（如果循环语句的长度超过了两⾏或者存在着嵌套循环，尽量避免使⽤I,j,k之类的变量，应该使⽤有意义的变量）·临时变量的命名应当有意义·所有布尔型变量的命名能够直接从名称上看出为真的条件·枚举类型的变量名称应当包含了基础类型，能够⽅便的分辨变量的类型。

例如：⽤Color变量表⽰ ColorRed, ColorGreen枚据类型的值。

·命名的常量应当代表了抽象的实体⽽⾮他们所代表的值·从变量命名中应当可以看出变量的作⽤域是局部变量，模块变量或者全局变量·变量的名称中不同的单词⾸字母要⼤写，以⽅便阅读·如果不是绝对必须，尽量避免使⽤短的名称·如果变量中单词的缩写只能缩短⼀两个字符则使⽤单词的完全拼写·所有单词的缩写规则应当⼀致·名称具有误导性·两个不同的命名具有相似的含义·不同的命名拼写很相似，仅差⼀两个字符·在变量名称中不应当使⽤数字·完全和变量含义不相关的命名使⽤下⾯的三种⼤写标识符约定。

ASP.NET（C#）命名规范（前缀）

（C#）命名规范（前缀）基本数据类型数据类型数据类型简写标准命名举例Array arr arrShoppingListBoolean bln blnIsPostBackByte byt bytPixelValueChar chr chrDelimiterDateTime dtm dtmStartDateDecimal dec decAverageHeightDouble dbl dblSizeofUniverseInteger int intRowCounterLong lng lngBillGatesIncomeObject obj objReturnValueShort shr shrAverageSingle sng sngMaximumString str strFirstNameWinForm Control 命名规范数据类型数据类型简写标准命名举例Label lbl lblMessageLinkLabel llbl llblTodayButton btn btnSaveTextBox txt txtNameMainMenu mmnu mmnuFileCheckBox chk chkStockRadioButton rbtn rbtnSelectedGroupBox gbx gbxMainPictureBox pic picImagePanel pnl pnlBodyDataGrid dgrd dgrdViewListBox lst lstProductsCheckedListBox clst clstCheckedComboBox cbo cboMenuListView lvw lvwBrowserTreeView tvw tvwTypeTabControl tctl tctlSelectedDateTimePicker dtp dtpStartDateHscrollBar hsb hsbImageVscrollBar vsb vsbImageTimer tmr tmrCountImageList ilst ilstImageToolBar tlb tlbManageStatusBar stb stbFootPrintOpenFileDialog odlg odlgFileSaveFileDialog sdlg sdlgSaveFoldBrowserDialog fbdlg fgdlgBrowserFontDialog fdlg fdlgFootColorDialog cdlg cdlgColorPrintDialog pdlg pdlgPrintWebParts Control类型前缀⽰例AppearanceEditorPart paed paedPart1BehaviorEditorPart pbed pbedPart2CatalogZone zca zcatCityConnectionsZone zcon zconDataBaseDeclarativeCatalogPartpdca pdcaPart1EditorZone zed zedNewsImportCatalogPart pica picaPartLayoutEditorPart pled pledNews PageCatalogPart ppca ppcaMail PropertyGridEditorPart ppge ppgeServer ProxyWebPartManagermpwp mpwpWeb WebPartManager mwp mwpSite1 WebPartZone zwp zwpSite2WebControl 命名规范类型前缀⽰例Adrotator adrt adrtTopAd BulletedList blst blstCityButton btn btnSubmit Calendar cal calMettingDates CheckBox chk chkBlue CheckBoxList chkl chklFavColors CompareValidator valc valcValidAge CustomValidator valx valxDBCheck DropDownList drop dropCountries DataGrid dgrd dgrdTitles DataList dlst dlstTitles RangeValidator valg valgAge FileUpLoad fup fupImage HiddenField hfld hfldName HyperLink hlk hlkDetailsImage img imgAuntBetty ImageButton ibtn ibtnSubmit ImageMap imap imapSiteLabel lbl lblResults LinkButton lbtn lbtnSubmit ListBox lst lstCountries Literal ltl ltlTitleLocalize loc locChina MultiView mvw mvwForm1Panel pnl pnlForm2 PlaceHolder plh plhFormContents RadioButton rad radFemale RadioButtonList radl radlGender RegularExpression vale valeEmail_Validator Repeater rpt rptQueryResults RequiredFieldValidatorvalr valrFirstName SubStitution subs subsTime TextBox txt txtFirstName Table tbl tblCountryCodes TableCell tblc tblcGermany TableRow tblr tblrCountry ValidationSummary vals valsFormErrors View vw vwCityWizard wiz wizRegisterXmlValidation Control类型前缀⽰例CompareValidator valc valcValidAge CustomValidator valx valxDBCheck RangeValidator valg valgAge RegularExpressionValidatorvale valeEmail RequiredFieldValidator valr valrFirstName ValidationSummary vals valsFormErrors Navigation Control类型前缀⽰例Menu mnu mnuUser1Menu mnu mnuUser1SiteMapPath smp smpSite1TreeView trvw trvwMenuLogin Control类型前缀⽰例ChangePassword cpwd cpwdUser1 CreateUserWizard cuw cuwLoginLogin log logCenter LoginName logn lognUser LoginStatus logs logsUser LoginView logv logvUser PasswordRecovery pwdr pwdrUserData Control类型前缀⽰例AccessDataSource ads adsPubsDataList dlst dlstTitles DetailView dvw dvwTitles FormView fvw fvwFonts GridView gvw gvwCity ObjectDataSource ods odsMenus Repeater rpt rptQueryResults ReportViewer rvw rvwRecord SiteMapDataSource smds smdsSite SqlDataSource sds sdsBooks XmlDataSource xds xdsTitles 命名规范数据类型数据类型简写标准命名举例Connection con conNorthwind Command cmd cmdReturnProducts Parameter parm parmProductID DataAdapter dad dadProducts DataReader dtr dtrProducts DataSet dst dstNorthWind DataTable dtbl dtblProduct DataRow drow drowRow98 DataColumn dcol dcolProductID DataRelation drel drelMasterDetail DataView dvw dvwFilteredProducts。

简述.net命名规则和命名习惯

简述.net命名规则和命名习惯下面小编给大家分享的是简述命名规则和命名习惯，在这里详细的介绍简述命名规则和命名习惯，希望对大家有所帮助.　命名规则就是给变量取名的一种规则，一般来说，命名规则就是为了让开发人员给变量或者命名空间取个好名，不仅要好记，还要说明一些特性。

在C#里面，有常用的一些命名的习惯如下。

qPascal大小写形式：所有单词的第一个字母大写，其他字母小写。

qCamel大小写形式：除了第一个单词，所有单词的第一个字母大写，其他字母小写。

DONET编码规范

Attribute Pascal XmlElementAttribute，最后要以 Attribute 结束
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：
BackColor
Camel 大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
.Net 的编码规范
【规则】：编程时必须遵守的约定。〖建议〗：编程时必须加以考虑的约定。
1. 代码格式【规则 1-1】全部代码使用 TAB 键缩进。【规则 1-2】代码行的长度小于 120 个字符。【规则 1-3】“{”放在行首，“}”新起一行也在行首。【规则 1-4】不要在相关的一组类或者是一个模块中使用不同的代码格式。【规则 1-5】成员按照一定的顺序，并且使用#region 分组。
2. 命名规范【规则 2-1】使用英文命名标识符。【规则 2-2】使用 Pascal 大小写和 Camel 大小写命名标识符。
Pascal 大小写是每个单词的首字母大写。例如：BackColor。 Camel 大小写是第一个单词的首字母小写，其余单词的首字母大写。例如：backColor。【规则 2-3】不使用匈牙利命名法。〖建议 2-1〗注意缩写的使用。如果不是绝对必须，尽量避免使用短的名称。如果标识符中单词的缩写只能缩短一两个字符则使用单词的完全拼写。所有单词的缩写规则应当一致。〖建议 2-2〗标识符应当直观且可以拼读，可望文知意，不必进行“解码”。【规则 2-4】DLL Assembly 命名使用它所包含的命名空间。【规则 2-5】文件名和所包含的类名相同。【规则 2-6】所有布尔型变量的命名能够直接从名称上看出为真的条件。【规则 2-7】程序中不要出现仅靠大小写区分的相似的标识符。

软件产品版本号命名规范

软件产品版本号命名规范软件产品版本号命名规范1、⽬的规范软件产品版本号，避免软件测试、发布时软件各模块版本不兼容问题。

2、范围C3M平台软件及绿⾊⾏动管理平台。

3、命名规范软件产品版本号命名规范参考 .Net Framework风格的版本号命名格式，以：主版本号.次版本号.内部版本号.修订号四位表⽰。

软件初版时，版本号为：1.0.0.0。

主版本号：标识软件架构、设计思想，主版本号不同的程序集不可互换，即使具有相同名称也不可互换。

软件架构、设计思想改变或⼤量重写，主版本号加1。

主版本号改变，不⽀持向后兼容性，次版本号、内部版本号及修订号复位为0。

次版本号：当在原有基础上增加了部分功能，涉及数据库的改动，次版本号加1，内部版本号及修订号复位为0。

内部版本号：当软件各模块间接⼝变更时，内部版本号加1，修订号复位为0。

只要有某个或某⼏个模块的接⼝发⽣变动，所有模块的内部版本号统⼀增加1。

修订号：名称、主版本号、次版本号、内部版本号都相同，但修订号不相同的程序集可以完全互换。

以软件编译⽇期（⽉⽇）4位数字作为修订号，如10⽉5号，则为1005。

当天发布的多次软件，⽤后编译的软件程序完全替换前边编译的软件程序。

主版本号、次版号及内部版本号，其中任何⼀个如果需要变更，需要向软件负责⼈申请，由软件负责⼈确定。

软件负责⼈将统⼀修改软件产品版本号，并通知所有相关开发⼈员。

开发⼈员每次的改动必须写开发⽇志，注明改动了哪些东西，修正了哪些BUG，是否对其它模块有影响，是否对数据库有改动。

软件产品所需要的主版本号、次版本号、内部版本号，出现任何⼀个变更，软件产品需要整体升级。

4、软件模块版本号软件各模块需要独⽴的主版本号、次版本号、内部版本号，其中对公共模块或公共组件的版本号，为完全独⽴的版本号，与软件产品版本号的主版本号，次版本号，内部版本号⽆关。

对业务模块的版本号，其主版本号与软件产品的版本号⼀致，次版本号，内部版本号为独⽴版本号。

DotNet命名规范

C#.NET 语言命名规范— — 陈进学总结---------------------------------------------------------------------------------类命名<规则1-1> 使用Pascal 规则命名类名，即首字母要大写。

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

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

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

<规则1-5> 文件名要能反映类的内容，最好是和类同名。

类字段<规则2-1> 用camel 规则来命名类成员变量名称，即首单词（或单词缩写）小写。

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

<规则2-3> 坚决禁止在普通变量前加“m_”（这是VC 老命名规则）。

方法<规则3-1> 方法名采用Pascal 规则，第一个字符要大写。

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

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

属性<规则4-1> 使用名词定义属性，属性使用Pascal 规则，首字符大写。

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

本文档来自网络，本人仅上传分享。

分享地址Blog ：参数<规则5-1> 参数采用camel规则命名，且首字符小写。

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

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

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

常量<规则6-1> 只读常量使用Pascal命名规则，即首字母大写。

.NET命名规范中文版

.NET命名规范中⽂版避免使⽤由经常使⽤的名称空间复制的类型名。

类型名不能使⽤下列词语。

System Collections Forms UI 避免避免使⽤与常⽤关键词词语选择避免冲突的标识符。

例如，避免使⽤下列词语。

AddHandlerAddressOf Alias And AnsiAs Assembly Auto BitAnd BitNotBitOr BitXor Boolean ByRef ByteByVal Call Case Catch CBoolCByte CChar CDate CDec CDblChar CInt Class CLng CObjConst CShort CSng CStr CTypeDate Decimal Declare Default DelegateDim Do Double Each ElseElseIf End Enum Erase ErrorEvent Exit ExternalSource False FinallyFor Friend Function Get GetTypeGoto Handles If Implements ImportsIn Inherits Integer Interface IsLet Lib Like Long LoopMe Mod Module MustInherit MustOverrideMyBase MyClass Namespace New NextNot Nothing NotInheritable NotOverridable ObjectOn Option Optional Or OverloadsOverridable Overrides ParamArray Preserve PrivateProperty Protected Public RaiseEvent ReadOnlyReDim Region REM RemoveHandlerResumeReturn Select Set Shadows SharedShort Single Static Step StopString Structure Sub SyncLock ThenThrow To True Try TypeOfUnicode Until Variant When WhileWith WithEvents WriteOnly Xor evalextends instanceof package var不要使⽤缩写。

.NET开发规范

.NET开发规范编写：审核：批准：目录1.概述 (4)2.命名规范 (4)2.1.类、参数和方法的命名规范 (4)2.2.接口命名规范 (4)2.3.动态语言文件命名规则 (5)2.3.1.格式：性质_描述 (5)2.4.客户端JavaScript规范 (5)2.4.1.变量命名规范 (5)2.4.2.对象命名规范 (5)2.5.控件命名规范 (5)2.6.图片的命名原则 (6)2.7.数据库命名规范 (7)2.7.1.命名规范原则 (7)2.7.2.数据库规范 (7)2.7.3.表命名规范 (7)2.7.4.字段规范 (8)2.7.5.视图规范 (8)2.7.6.存储过程规范 (8)2.7.7.函数规范 (8)2.7.8.索引命名规范 (8)2.7.9.关联命名 (8)2.7.10.设计规范 (8)3.编码规范 (8)3.1.C#代码编写 (8)3.2.Request、Session、Application使用规范 (12)3.3.HTML标记语言编码规范 (12)3.4.注释规范 (12)3.5.异常规范 (15)1.概述为了保持应用程序、组件、文件的一致性，便于阅读和管理代码和结构，提高开发效率和产品的标准化，特制订一套开发规范和标准（包括命名规范和编码规范）。

命名规范将包括：类和参数的命名规范、接口命名规范、数据库命名规范、ASP命名规范、JavaScript命名规范、控件命名规范等。

编码规范将包括：C#编码规范、注释规范、HTML编码规范、编码规范、异常规范等。

2.命名规范2.1.类、参数和方法的命名规范2.1.1.用名词或名词短语命名类。

2.1.2.使用Pascal大写注记：Pascal 大小写形式－所有单词第一个字母大写，其他字母小写。

2.1.3.不要使用匈牙利命名法2.1.4.用有意义的，描述性的词语来命名变量- 别用缩写。

用name, address, salary等代替nam, addr, sal 。

asp.net命名规范

命名规范1.⽤Pascal规则来命名⽅法和类型。

(笔者注:单词⾸字母⼤写)public class DataGrid{public void DataBind(){}}2.⽤Camel规则来命名局部变量和⽅法的参数. (笔者注:⾸单词⼩写，其余单词⾸字母⼤写；笔者使⽤此⽅式命名成员变量) public class Product{private string _productId;private string _productName;public void AddProduct(string productId,string productName){}}补充:使⽤匈⽛利⽅式命名局部变量，⽅法参数和控件命名。

如int iCount,string strNameLabel的lblTitle,Button btnSubmit等3.所有的（私有）成员变量前加前缀“_”。

public class DataBase{private string _connectionString;}不要使⽤public成员变量，⽽⽤.net⾥的属性get,set4.接⼝的名称加前缀 “I”。

public interface IConvertible{byte ToByte();}5.⾃定义的属性以“Attribute”结尾。

public class TableAttribute:Attribute{}6.⾃定义的异常以Exception结尾。

public class TableAttribute:Attribute{}7.⽅法的命名。

⼀般将其命名为动宾短语。

public class File{public void CreateFile(string filePath){}public void GetPath(string path){}}8．局部变量的名称要有意义。

不要⽤x，y，z等等，⽤For循环变量中可使⽤i, j, k, l, m, n。

.net语法规则

.NET语法规则.NET是一个软件开发平台，它提供了一个统一的框架，用于构建各种类型的应用程序。

在使用.NET开发应用程序时，我们需要遵循一些特定的语法规则。

下面是一些常见的.NET语法规则：1. 命名规则在.NET中，命名规则非常重要，它有助于代码的可读性和可维护性。

以下是.NET中的一些命名规则：命名空间（Namespace）应该使用帕斯卡命名法，即每个单词的首字母大写，不包含下划线或其他特殊字符。

例如：System.Collections。

类（Class）、接口（Interface）、枚举（Enum）、结构体（Struct）等应该使用帕斯卡命名法。

例如：public class MyClass。

方法（Method）和属性（Property）应该使用驼峰命名法，即第一个单词的首字母小写，后续单词的首字母大写。

例如：public void MyMethod()。

常量（Constant）应该使用大写字母和下划线命名，以增加可读性。

例如：public const int MAX_COUNT = 100。

2. 类型规则在.NET中，类型规则定义了如何声明和使用各种类型。

以下是一些常见的类型规则：类（Class）是.NET中最常用的类型。

一个类可以包含字段、方法、属性等成员，并可以被其他类继承。

例如：public class MyClass{private int myField;public void MyMethod(){// 方法的实现代码}public int MyProperty { get; set; }}接口（Interface）定义了一组相关方法和属性的合同。

其他类可以实现接口，并提供对接口中定义的成员的具体实现。

例如：public interface IMyInterface{void MyMethod();int MyProperty { get; set; }}枚举（Enum）定义了一组命名的常数值。

NET编码规范

.NET编码规范1 目的（1）为了统一公司软件开发设计过程的编程规范。

（2）使开发人员能很方便地理解每个变量、控件、类、方法的意义。

（3）保证编写出的程序都符合相同的规范，保证一致性、统一性。

（4）编码规范和约定必须能明显改善代码的可读性，并有助于代码管理、分类，范围适用于企业所有基于.NET平台的软件开发工作。

2 代码规范2.1 必须遵守的规范（Rules）（1）局部变量的名称要有意义，尽量用对应的英文单词、词组命名。

比如“用户姓名”变量，不要用aa、bb、cc等来命名，而要使用userName。

（2）不要使用单个字母的变量，如i、n、x等，而要使用index、count、sum、temp 等。

用于循环迭代的变量（循环变量）例外。

（3）应该使用Pascal命名法命名方法名、属性名、类名和命名空间，且一般将方法命名为动宾短语，如：ShowDialog();CreateFile();GetPath();FillListView();（4）用Camel命名法命名局部变量和方法的参数。

以上几条综合举例如下。

public class Person{private string firstName; // 使用Camel 方式命名public string FirstName() // 使用Pascal 方式命名{get {}set {}}public void DoSomething() // 使用动宾短语作为方法名{}public void Buy(string productName){}}（5）仅使用匈牙利命名法对WinForms和Web控件命名，禁止使用textbox1、gridview1等默认命名。

（6）所有代码必须保证有足够的注释，注释量要求在15%以上。

需奥注释的内容包括以下几种：1）关键性语句（如关键的变量声明，条件判断等）2）类名前的文档注释（以//开头的注释）包括类的简单功能说明、使用方法等。

.net开发变量命名及编码规范

研发部变量命名及编码规范(/)一、命名规则==================================================================1.Camel变量命名法--userId2.Pascal变量命名法--UserId3.匈牙利变量合法法–strUserId1）：变量Camel变量命名userId 业务逻辑对象bllNews 实体objNewsClass2）：循环变量：for(int i=0;i<n;i++);3）：控件命名：如，chkSel,btnAdd,grdProduct,rptNews,txtTitle,lblName,lnkProduct…4）：方法、函数如：protect void AddNews() ，避免使用displyNews,避免使用有歧义有冲突的名称，如DataBind()；DelUserById BindData5）：html控件命名：input(text radio check submit reset button file hidden) 命名：txtTitle,radSel,chkSel,sumbitAdd,rst,btn,file,hdn6）：文件命名：news_list,news_add,news_edit,news_info（避免使用dispay，look，detail）news_class_list,news_class_add,news_class_edit,news_class_info母版页不能与普通文件命名重复，（避免命名空间重复）7）：文件夹命名：images(icon),css,js,include,upload,database（备用：resource,bak,common,fla）8）：传递参数命名：news_class_id,news_id,product_class_id,page,action,type二、注释1）：文件头（作者注释）//**************************************************//功能：客户类型选择（公共窗体）////开发：王俊//日期：2009-8-23//最后修改日期：2009-8-23//修改详情：2009-9-11 王洪剑修正部分注释格式//**************************************************2）：模块功能头部注释/// <summary>/// 分页显示数据/// </summary>/// <param name="pageIndex" type="int">pageIndex</param>/// <returns type="string"></returns>3）：模块内部重要代码注释if (list.Product_Passed == "1"){sb.Append("<span class=\"greenInfo\">已通过</span>");}//判断是否通过else4）：自动生成代码与个人手写代码块注释#region王洪剑///<summary>///方法：根据loanId删除对象///开发：王洪剑///日期：-9-11///最后修改日期：-9-11///</summary>///<param name="loanId">贷款编号</param>///<param name="delValue">0:已删除1:未删除</param>protected void DelLoanById(int loanId,string delValue){}#endregion5）：同一方法内不同作用的代码隔一行三、代码书写1）：不规范if(news_passed==”1”){lblTitle=”通过”;}else{lblTitle=”不通过”;}改进后：lblTitle=(news_passed==”1”)?”通过”:”不通过”;2）：当前文件公共变量，采用私有对象方式protected void grdNewsBind(){int intNewsId=Convert.ToInt32(request.querystring[“news_id”]);Hope_T_NewsManager…..}protected void DelNews(){int intNewsId=Convert.ToInt32(request.querystring[“news_id”]);Hope_T_NewsManager…..}改进：private int intNewsId{get{in t id= Convert.ToInt32(request.querystring[“news_id”].ToString().Replace(“’”,””));return id;}}3）：如果不传递参数会报错的页面要做出错处理protected void Page_Load(){if(request.querystring[“news_id]==null){response.redirect(“news_list.aspx”);}else{….}}4）：无数据时要做空数据判断if(listNews.count>0){}elsereturn “抱歉，暂无数据……”;5）：使用StringBuilder方法，使用换行：sb.Append(“<ul>\n”);sb.Append(“<li>” + listNews.NewsTitle + “</li>\n”);sb.Append(“</ul>\n”);6）：null判断：可能存在null列的要做是否为null判断7）：Page.ClientScript.RegisterStartupScript(typeof(string), "Failure", "alert(\"仅可上传\”);", true);四、交互方式1）：确认删除：“此操作将删除当前记录，是否继续？”；(添加确认：“是否确认添加？”)2）：必填字段后加* 号，放在文本框前面，文字后面3）：文字标签不加冒号；。

微软推荐的.net命名规范

微软推荐的.net命名规范许多命名约定都与标识符的⼤⼩写有关。

值得注意的是，公共语⾔运⾏库 (CLR) ⽀持区分⼤⼩写和不区分⼤⼩写的语⾔。

本主题中描述的⼤⼩写约定可帮助开发⼈员理解和使⽤库。

⼤⼩写样式下列术语描述了标识符的不同⼤⼩写形式。

Pascal ⼤⼩写将标识符的⾸字母和后⾯连接的每个单词的⾸字母都⼤写。

可以对三字符或更多字符的标识符使⽤ Pascal ⼤⼩写。

例如：BackColor⼤⼩写混合标识符的⾸字母⼩写，⽽每个后⾯连接的单词的⾸字母都⼤写。

例如：backColor⼤写标识符中的所有字母都⼤写。

例如：IO标识符的⼤⼩写规则如果标识符由多个单词组成，请不要在各单词之间使⽤分隔符，如下划线（“_”）或连字符（“-”）等。

⽽应使⽤⼤⼩写来指⽰每个单词的开头。

下列准则是⽤于标识符的通⽤规则。

对于由多个单词组成的所有公共成员、类型及命名空间名称，要使⽤ Pascal ⼤⼩写。

注意，这条规则不适⽤于实例字段。

由于中详细说明的原因，不应使⽤公共实例字段。

对参数名称使⽤⼤⼩写混合。

下表汇总了标识符的⼤⼩写规则，并提供了不同类型标识符的⽰例。

标识符⼤⼩写⽅式⽰例类Pascal AppDomain枚举类型Pascal ErrorLevel枚举值Pascal FatalError事件Pascal ValueChanged异常类Pascal WebException只读的静态字段Pascal RedValue接⼝Pascal IDisposable⽅法Pascal ToString命名空间Pascal System.Drawing参数Camel typeName属性Pascal BackColor⾸字母缩写词的⼤⼩写规则⾸字母缩写词是由术语或短语中各单词的⾸字母构成的单词。

例如，HTML 是 Hypertext Markup Language 的⾸字母缩写。

只有在公众⼴为认知和理解的情况下，才应在标识符中使⽤⾸字母缩写词。