首页 编码规范方案(1)

编码规范方案(1)

举报
开通vip

编码规范方案(1)应用程序设计/命名及编码规范避免使用.NETnamespace占用的词汇.避免使用与关键字冲突的词汇关键字列表:AddHandlerAddressOfAliasAndAnsiAsAssemblyAutoBaseBooleanByRefByteByValCallCaseCatchCboolCbyteCcharCdateCdecCDblCharCintClassCLngCobjConstCshortCSngCStrCtypeDateDecimalDeclareDefaultDelegateDimDoDoubleEach...

编码规范方案(1)
应用程序设计/命名及编码 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 避免使用.NETnamespace占用的词汇.避免使用与关键字冲突的词汇关键字列表:AddHandlerAddressOfAliasAndAnsiAsAssemblyAutoBaseBooleanByRefByteByValCallCaseCatchCboolCbyteCcharCdateCdecCDblCharCintClassCLngCobjConstCshortCSngCStrCtypeDateDecimalDeclareDefaultDelegateDimDoDoubleEachElseElseIfEndEnumEraseErrorEventExitExternalSourceFalseFinalizeFinallyFloatForFriendFunctionGetGetTypeGotoHandlesIfImplementsImportsInInheritsIntegerInterfaceIsLetLibLikeLongLoopMeModModuleMustInheritMustOverrideMyBaseMyClassNamespaceNewNextNotNothingNotInheritableNotOverridableObjectOnOptionOptionalOrOverloadsOverridableOverridesParamArrayPreservePrivatePropertyProtectedPublicRaiseEventReadOnlyReDimRegionREMRemoveHandlerResumeReturnSelectSetShadowsSharedShortSingleStaticStepStopStringStructureSubSyncLockThenThrowToTrueTryTypeOfUnicodeUntilvolatileWhenWhileWithWithEventsWriteOnlyXorevalextendspartialyield(.net2.0)一、命名规则Namespace命名:采用以下形式命名namespace:公司名称.项目名称.作者例如:ZheKe.ZheKeMarketing.PSGPascal形式(每个字母开头大写)应使用解决 方案 气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载 的名称或者开发代号开头.如果作为产品出售,应以公司品牌开头.同一个解决方案,应尽量写在同一个顶级NameSpace中。每个项目应设置一个二级NameSpace.并以项目名命名.如果名词有复数意义,应采用其复数形式.例如System..Web.UserControls.不允许namespace和类重名.类命名:1.必须使用Pascal形式2.类名选词必须可以完全准确地表示其含义。不允许使用晦涩、不常用的词汇。也避免选择意义太广泛容易发生歧异的词。例如表示车辆应选用Vehicles,而不宜选用Cars.员工应选用Employees,而不宜选用Personels.一般而言,词汇的选用必须在项目开始以前经过充分讨论,列出词汇表。各成员应严格遵守选词规则。避免同一个意义使用两个不同的词汇的情况。3.必须使用名词或者名词复合词,如果仅具有动词含义,则使用其主语形态。例如Importor.4.谨慎的使用缩写词5.不允许使用表示数据类型的前缀.6.不允许使用下划线连接7.使用复合词来表示派生类.例如派生自LinkButton的类可命名为SubmitLink.又如DataAccessException.8.接口一般以I为前缀.并且第二个字母也大写.9.使用相同的词汇表示接口和相关类,例如: publicinterfaceIComponent{}publicclassComponent:IComponent{} 方法 快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载 (Mothed)命名1.    使用动词-名词的方法来命名对给定对象执行特定操作的例程,如CalculateInvoiceTotal(),RemoveAll(),GetCharArray(),Invoke()2.方法名必须可以详尽描述其意义。变量命名变量与方法的参数使用Camel(匈牙利)命名法进行命名:Camel:第一个单词的第一个字母小写,后面的单词首字母大写命名:totalCount属性(Property)命名1.使用名词或者名词复合词.2.有复数意义时应使用其复数形式.3.不要与其数据类型相同4.在面向对象的语言中,在类属性的名称中包含类名是多余的,如Book.BookTitle。而是应该使用Book.Title。5.布尔值属性应该包含Is,这意味着Yes/No或True/False值,如IsFileFound。6.使用#Region将所有Property定义组织在一起.以便管理源代码.7.如果有缺省值则直接赋值给相关私有成员变量8.不要在类中直接实用。事件(Event)命名)1.使用EventHandler后缀来标识事件处理器.2.通常指定sender和e两个参数.sender类型总是object.而e与事件所对应的Exception类型相同.3.使用动词表示事件.例如Click,或者名词动词组成的复合结构.例如TaskAbort.4. 使用进行时态表示事件发生之前,使用过去时态表示事件发生之后,例如TaskAborting和TaskAborted.二、编码规范在开发中保持良好的编码规范是十分重要的。编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类。1.必须使用智能缩进代码。并且制表符和缩进大小均为4字符。不允许插入空格缩进。(使用VISUALSTUDIO.NET的缺省设置)。2.在代码中必须垂直对其左右花括号。不允许将左右花括号写在一行上。3.同一行仅能容纳一条语句.4.    当一行内容太长而必须换行时,在后面换行代码中要使用缩进格式,如下:stringinserString="InsertIntoTableName(username,password,email,sex,address)"5.推荐每行语句以this开头以便使用代码助手.加速书写效率与准确性。6.尽量不给较长语句换行以提高可读性。7.避免使用大文件。如果一个文件里的代码超过500行,必须考虑将代码分开到不同类中。8.避免写太长的方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。一行控制在80个字符之内.9.一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。10.在用到的时候再定义私有变量(Field),不要在类开头马上定义。三、代码组织结构1.采用如下顺序组织类中的代码:using语句组名称那空间声明类说明类声明私有变量公共属性与相应私有变量组方法声明2.公共属性和相应私有变量必须写在一起.并且一起被注释例如://////公共特性(property):资源文件(图像文件及脚本资源)引用路径///相对于应用程序根路径的地址,可不以/符号结尾///privatestringresourcePathpublicstringResourcePath{…}3.注释1.注释时连写入三个斜线符号,VisualStudioIDEC#编辑器会自动产生///帮助产生 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 XML注释,在注释模块,类,重要特性,方法时必须使用,而行间注释不能使用2. 注释必须使用完整的中文陈述性语句.避免注释产生多义性而更难于理解.3.避免多余的或不恰当的注释.或幽默的可有可无的注释.4. 注释中必须使用书面语言.避免使用口语或非正式的措辞.注释不可出现错别字或多余的语气词.5.模块注释:书写于.CS文件开头.分行注明模块名,意义及功能,作者,编写时间.修改人员须注明修改人姓名及时间.以上项必须全部使用中文.日期格式采用2005-12-26格式(这里你可以修改(VS安装目录\VC#\VC#Wizards\CSharpAddClassWiz\Templates\2052\NewCSharpFile.cs,如果你是使用向导来产生类的话,那只要把前面的CsharpAddClassWiz改成CsharpClassWiz,或者你把这两个文件同时都改过来)模版文件,在这里面可以添加如下代码,这样可以减少这部分烦杂的工作)6.类注释:书写于类定义紧上方.说明主要功能.使用的算法以及注意事项.可分行说明.7.行间注释:以双斜线开始。必须先于被注释的代码.并且要紧挨着代码行.允许在行尾增加注释.这一情况在分别注释多行代码时除外.8.注释中如出现中英文混排,应注意使用适当的大小写拼写形式。如果英文做为单字出现,则使用全部小写。(专有名词,组织、公司名,以及缩写除外。)如出现由多个单词组成的专有名词,则每个单词首字母大写。如MicrosoftInternetExplorer4.异常处理1.不要“捕捉了异常却什么也不做”。如果隐藏了一个异常,你将永远不知道异常到底发生了没有。2.发生异常时,给出友好的消息给用户,但要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。3.只捕捉特定的异常,而不是一般的异常。4.不必在所有方法中捕捉一般异常。不管它,让程序崩溃。这将帮助你在开发周期发现大多数的错误。5.不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如,当你写文件时,处理异常FileIOException.6.别写太大的try-catch模块。如果需要,为每个执行的任务编写单独的try-catch模块。这将帮你找出哪一段代码产生异常,并给用户发出特定的错误消息7.如果应用程序需要,可以编写自己的异常类。自定义异常不应从基类SystemException派生,而要继承于IApplicationException。5.空格与空行1.在类定义,方法定义,公共属性定义前留一空行2.逻辑代码段前留一空行3.定义公共属性的get和set过程之间不留空行6.常用控件命名控件名      前缀TextBox      txtCheckBox    chkDropDown    drpLabel      lblRadioButton    rdoButton      btnDataGrid    dg列表用lst开头(DataList,Repeater等)
本文档为【编码规范方案(1)】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
is_654168
暂无简介~
格式:doc
大小:24KB
软件:Word
页数:10
分类:
上传时间:2022-08-05
浏览量:2