编码规范文档

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

1、目录目录11.编写目的22.程序命名规范2基本约定2控件命名规范4ADO.NET控件命名规范6自定义控件命名规范6类型声明6常量7类的命名7抽象类定义7密封类定义8方法定义8虚方法定义8类的成员定义8结构定义8结构成员定义9接口定义9接口的方法和成员定义9H定义异常定义9注释规范91.编写目的为了使团队中的每一位成员都形成统一的开发约定，特制定本规范文档，在今后的开发过程屮，请严格按照此文档约定的规则进行编码。通过此规范，希望可以给各程序员之间起到沟通的桥梁的作用，并增强程序的可读性。如在使用过程中，碰到本文档

2、中没进行约定的规则，待商议后对该文档进行补充完善。2.程序命名规范基本约定•所冇的命名名称都必须使用能直接体现具体含义的名字。不能使用X,Y,乙等无意义的名称进行定义，除循环变量除外。•所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开如：publicclassCisLogin{TextBoxtxtUserName;//TextBoxtxtPassWord;//publicLogin(){})•类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类,文件和文件夹的名称也应该精确地

3、说明它们的用途。如：文件名：Login.cs类名:publicclassCisLogin•大括号”{“耍新起一行。正确编写：publicclassCisLogin{}错误编写:publicclassCisLogin{}•switch语句一定要有default来处理意外情况。•同程序外部连接(如连接数据库、接口、文件等)一定要捕获任何类型的异常(try)给出友好的消息给用户，必要时用FI志记录错课的细节，包括发主的时间，和相关方法，类名等。•始终使用”{}“包含if/clsc下的语旬，即使只冇一条语句。正确编写：

4、if(true){//语句。}错误编写：if(true)//语句。•把引用的系统的namespace和自定义或第三方的分开。usingSystem;usingSystem.Web;usingSystem.Web.Security;usingSystem.Web・UT;usingSystem.Web.UT・WebControls;usingMYNtimeSpace・NcimeSpace;•不同函数或方法之间，需要用空行來分开。如：publicclassClsl-ogin{publicLogin(){}Public

5、"Login(){}}•不在代码屮使用具体的路径和驱动器名，必须使用相对路径。•代码的缩进用Tab,而不要用spaceo•使用某个控件的值吋，尽虽:命名局部变量。publicstringGetTitle(){stringStrTitle=lblTitle.Text;StrTitle+=StrTitle;returnStrTitle;}•一个方法只完成一个任务。不耍把多个任务组合到一个方法中。•避免使用大文件。如果一个文件里的代码超过300〜400tj,必须考虑将代码分开到不同类中。控件命名规范以下控件为常用的控

6、件命名规范，按英文字母进行升序排列。在此列表中未定义的控件,将后期补充完善。控件类型命名前缀举例3DPanelpnlpnlGroupADODataadoadoBiblioAnimatedbuttonanianiMailBoxButtonblnbtnOKCheckboxchkchkReadOnlyComboboxcbocboEnglishDropdownlistboxddlddlUserCommandbuttoncmdcmdExitCommondialogdigdlgFileOpcnCommunicationsc

7、omcomFaxControl(usedwithinprocedureswhenthespecifictypeisunknown)ctrctrCurrentDatadatdatBiblioData-boundcomboboxdbcbodbcboLanguageData-boundgriddbgrddbgrdQueryResultData-bound1istboxdblstdblstJobTypeDatacombodbcdbcAuthorDatagriddgddgdTitlosDatalistdbldblPubl

8、isherDatarepeaterdrpdrpLocationDatepickerdtpdtpPublishedDirectorylistboxdirdirSourceDrive1istboxdrvdrvTargetFilelistboxfilfilSourceFlatscrol1barfsbfsbMoveFormfrmfrmEntryFramefrafraLanguageGaugeg