c#编码规范(modified)

c#编码规范(modified)

ID:18277842

大小:56.00 KB

页数:11页

时间:2018-09-16

上传者:U-4649
c#编码规范(modified)_第1页
c#编码规范(modified)_第2页
c#编码规范(modified)_第3页
c#编码规范(modified)_第4页
c#编码规范(modified)_第5页
资源描述:

《c#编码规范(modified)》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

目录1目的12范围13规范内容13.1代码格式13.2注释(Comment)规范23.2.1模块(类)注释规范23.2.2类属性注释规范33.2.3方法注释规范33.2.4代码间注释规范33.3变量(Variable)命名规范43.3.1程序文件(*.cs)中的变量命名规则43.3.2控件命名规则83.4常量命名规范83.5类(Class)命名规范93.6接口(Interface)命名规范93.7方法(Method)命名规范93.8命名空间(NameSpace)命名规范1010 1目的为了保证企业编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。2范围适用于企业所有基于.NET平台的软件开发工作。3规范内容3.1代码格式所有的缩进为4个空格,使用VS.NET的默认设置。在代码中垂直对齐左括号和右括号。为了防止在阅读代码时不得不滚动源代码编辑器,每行代码或注释在1024*800的显示频率下不得超过一显示屏。当一行被分为几行时,通过将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。每一行上放置的语句避免超过一条。在大多数运算符之前和之后使用空格,这样做时不会改变代码的意图却可以使代码容易阅读。将大的复杂代码节分为较小的、易于理解的模块。编写SQL10 语句时,对于关键字使用全部大写,对于数据库元素(如表、列和视图)使用大小写混合。将每个主要的SQL子句放在不同的行上,这样更容易阅读和编辑语句,例如:SELECTFirstName,LastNameFROMCustomersWHEREState='WA'3.2注释(Comment)规范注释规范包括:模块(类)注释规范、类的属性、方法注释规范、代码间注释3.2.1模块(类)注释规范模块开始必须以以下形式书写模块注释:///

///模块编号:<模块编号,可以引用系统设计中的模块编号>///作用:<对此类的描述,可以引用系统设计中的描述>///作者:作者中文名///编写日期:<模块创建日期,格式:YYYY-MM-DD>///如果模块有修改,则每次修改必须添加以下注释://////Log编号:///修改描述:<对此修改的描述>10 ///作者:修改者中文名///修改日期:<模块修改日期,格式:YYYY-MM-DD>///3.2.2类属性注释规范在类的属性必须以以下格式编写属性注释://////属性说明///3.2.3方法注释规范在类的方法声明前必须以以下格式编写注释//////说明:<对该方法的说明>//////"><参数说明>//////<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>///3.2.4代码间注释规范代码间注释分为单行注释和多行注释:10 单行注释://<单行注释>多行注释:/*多行注释1多行注释2多行注释3*/代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。3.3变量(Variable)命名规范3.3.1程序文件(*.cs)中的变量命名规则程序中变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。1.类模块级的变量请用“m_”作前缀publicclassHello{privatestringm_Name;privateDateTimem_Date;}2.类的属性所对应的变量,采用属性名前加“m_”前缀的形式publicclassHello{10 privatestringm_Name;publicstringName{get{returnm_Name;}}}3.方法的变量不使用前缀publicclassHello{voidSay(){stringSayWord;}}4.方法的参数使用“p_”作为参数publicclassHello{voidSay(stringp_SayWord){10 }}补充说明:针对异常捕获过程中的Exception变量命名,在没有冲突的情况下,统一命名为e;如果有冲突的情况下,可以重复e,比如:ee。例:Try{//yourcodetry{//code}catch(Exceptionee){//yourcode}}catch(Exceptione){//yourcode10 }补充:如果捕获异常不需要作任何处理,则不需要定义Exception实例例:try{//yourcode}catch(Exception){}5.鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。每个单词的第一个字母都是大写。6.即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如i或j。7.在变量名中使用互补对,如min/max、begin/end和open/close。8.不要使用原义数字或原义字符串,如for(i=0;i<7;i++),而是使用命名常数,如for(i=0;i
当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。
关闭