NET代码和界面规范

《NET代码和界面规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、NET代码和界面规范目的(1)为了统一公司软件开发设计过程的编程规范(2)使网站开发人员能很方便地理解每个目录、变量、控件、类、方法的意义(3)保证编写出的程序都符合相同的规范，保证一致性，统一性(4)编码规范和约定必须能明显改善代码的可读性，并有助于代码管理、分类规范适用于企业所有基于.NET平台的软件开发工作代码规范1.必须遵守的规范(Rules)(1)局部变量的名称要有意义，尽量用对应的英文命名，比如“用户姓名”变量，不要用aa、bb>cc等来命名，而要使用userName0(2)不要使用单个字母的变量，如i、n、x等，而要使用index

2、temp等。用于循环迭代的变量例外(3)应该使用Pascal命名方法名、属性名、类名和命名空间，且方法的命名一般将其命名为动宾短语，如：ShowDIalog()；CreateFile();GetPath();(4)用Gamel命名法命名局部变量和方法的参数以上几条综合举例如下：PublicclassPerson{PrivatestringfirstName;〃使用Camel方式命名PublicstringFirstName()〃使用Pascal方式命名{get()set()PublicvoidDoSomethingO〃使用动宾短语作为方法名{}

3、PublicvoidBuy(stringproductName){}}(5)仅使用匈牙利命名方法对WinForms和Web控件命名，禁止使用textboxKgridview1等默认命名，统一的控件前缀见该附录的后面部分(6)接口名称以大写I作为前缀，如Isortable,以便直观地区分接口和类。(7)使用名字空间的层次性结构来组织各种类和接口正确：usingMyOfficeDALntimespaceMyOfficeBLL错误：usingMyOfficeDALnamespaceMyOfficeBLL}(1)所有代码必须有足够的注释，注释要求在15

4、%以上。需要注释的内容包括以下几种：①关键性语句(如关键的变量声明，条件判断等)②类名前的文档注释(以///开头的注释)包括类的简单功能说明、使用方法等。③具有复杂参数列表的方法(2)代码缩进用Tab键，不要用空格键2.指导性规范(Guidelines)(1)对于超过3屏式以上的代码，建议使用region折叠(2)Web窗体建议以div方式布局(3)代码中DataSet、DataTable、DataView等对象,定义时建议将ds、dt、dv作为前缀。(4)在一个自定义的类中，建议将类屮各成员有规律地组织起来。从上至下的顺序:常量、变量、属性、

5、公有方法、私有方法。可以将每个部分用region划分开。⑸if/foreach/switch语句的嵌套不宜太多，建议不超过3层3.最佳实践(BestPractices)(1)避免写太长的方法。一个典型的方法代码应该控制在100行以内(包括注释、空行、括号占用的独立一行等)。一个方法的代码如果超过100行，应该考虑将其分解为不同的方法。(2)一个方法只完成一个任务。不要把太多的任务组合到一个方法屮，基石那些任务非常小。4.控件命名规范控件名称简写(前缀)LablelblTextBoxtxtButtonblnLinkButtonlnkbtnImag

6、eButtonimgbtnListBox1stDropDownListddlDataGriddgDataListdlCheckBoxchkCheckBoxListchklstRadionButtonrdoRadionButtonListrdolstImageimgPanelpnlCalendercalAdRotatorarTabletblRequiredFieldValidatorrfvCompareValidatorcvRangeValidatorrvRegularExpressionValidatorrevValidatorSummaryv

7、sCrystalReportviewerreptvewComboBoxcboDataGridViewdgvDataGridViewde白勺ColumncolGroupBoxgrpImageListilListViewlvListView的ColumnHeaderchMenuStripmsToolStripMenuItemtsmiPictureBoxpicStatusStripssStatusLabelslblTabControltabTabPagetpTimertmrToolStriptsToolStripLabeltslblToolStrip

8、ButtontsbtnToolStripDropDownButtontsbtnDomainUpDowndudTreeViewTvtvwWebBrows