编码规范文档教案

第1页总计22页目录目录..................................................................................................................................................11．编写目的...........................................................................................................................22．程序命名规范...................................................................................................................2基本约定...................................................................................................................................2控件命名规范...........................................................................................................................4ADO.NET控件命名规范........................................................................................................6自定义控件命名规范...............................................................................................................6类型声明...................................................................................................................................6常量...........................................................................................................................................7类的命名...................................................................................................................................7抽象类定义...............................................................................................................................7密封类定义...............................................................................................................................8方法定义...................................................................................................................................8虚方法定义...............................................................................................................................8类的成员定义...........................................................................................................................8结构定义...................................................................................................................................8结构成员定义...........................................................................................................................9接口定义...................................................................................................................................9接口的方法和成员定义...........................................................................................................9自定义异常定义.......................................................................................................................9注释规范...................................................................................................................................9第2页总计22页1．编写目的为了使团队中的每一位成员都形成统一的开发约定，特制定本规范文档，在今后的开发过程中，请严格按照此文档约定的规则进行编码。通过此规范，希望可以给各程序员之间起到沟通的桥梁的作用，并增强程序的可读性。如在使用过程中，碰到本文档中没进行约定的规则，待商议后对该文档进行补充完善。2．程序命名规范基本约定所有的命名名称都必须使用能直接体现具体含义的名字。不能使用X，Y，Z，等无意义的名称进行定义，除循环变量除外。所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开如:publicclassClsLogin{TextBoxtxtUserName;//TextBoxtxtPassWord;//publicLogin(){}}类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类，文件和文件夹的名称也应该精确地说明它们的用途。如：文件名：Login.cs类名：publicclassClsLogin大括号{要新起一行。正确编写：publicclassClsLogin{}错误编写：publicclassClsLogin{第3页总计22页}switch语句一定要有default来处理意外情况。同程序外部连接（如连接数据库、接口、文件等）一定要捕获任何类型的异常（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间，和相关方法，类名等。始终使用{}包含if/else下的语句，即使只有一条语句。正确编写：if(true){//语句。}错误编写：if(true)//语句。把引用的系统的namespace和自定义或第三方的分开。usingSystem;usingSystem.Web;usingSystem.Web.Security;usingSystem.Web.UI;usingSystem.Web.UI.WebControls;usingMYNameSpace.NameSpace;不同函数或方法之间，需要用空行来分开。如：publicclassClsLogin{publicLogin(){}Public~Login(){}}不在代码中使用具体的路径和驱动器名，必须使用相对路径。代码的缩进用Tab，而不要用space。使用某个控件的值时，尽量命名局部变量。publicstringGetTitle(){stringStrTitle=lblTitle.Text;StrTitle+=StrTitle;returnStrTitle;}一个方法只完成一个任务。不要把多个任务组合到一个方法中。第4页总计22页避免使用大文件。如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。控件命名规范以下控件为常用的控件命名规范，按英文字母进行升序排列。在此列表中未定义的控件，将后期补充完善。控件类型命名前缀举例3DPanelpnlpnlGroupADODataadoadoBiblioAnimatedbuttonanianiMailBoxButtonbtnbtnOKCheckboxchkchkReadOnlyComboboxcbocboEnglishDropdownlistboxddlddlUserCommandbuttoncmdcmdExitCommondialogdlgdlgFileOpenCommunicationscomcomFaxControl(usedwithinprocedureswhenthespecifictypeisunknown)ctrctrCurrentDatadatdatBiblioData-boundcomboboxdbcbodbcboLanguageData-boundgriddbgrddbgrdQueryResultData-boundlistboxdblstdblstJobTypeDatacombodbcdbcAuthorDatagriddgddgdTitlesDatalistdbldblPublisherDatarepeaterdrpdrpLocationDatepickerdtpdtpPublishedDirectorylistboxdirdirSourceDrivelistboxdrvdrvTargetFilelistboxfilfilSourceFlatscrollbarfsbfsbMoveFormfrmfrmEntryFramefrafraLanguageGaugegaugauStatusGraphgragraRevenueGridgrdgrdPricesGridViewgrvHierarchicalflexgridflexflexOrdersHorizontalscrollbarhsbhsbVolumeImageButtonibtnImageButtonImageimgimgIconImagecomboimgcboimgcboProduct第5页总计22页ImageListilsilsAllIconsLabellbllblHelpMessageLightweightcheckboxlwchklwchkArchiveLightweightcomboboxlwcbolwcboGermanLightweightcommandbuttonlwcmdlw