C# 代码编写规范

所需积分/C币:9 2013-05-29 10:29:11 243KB PDF
收藏 收藏
举报

C# 代码编写规范 目录 目录1目的..............................................................................................................................................2 1目的.......................................................................................................................................
4.4.16模块化则 4.4.17交凉规则 .4 45编程准则 14 4.5.1变量使尻 4.5.2数据库操作 14 4.5.3对象使用 4.5.4模坎设计原奶 4.5.5结构化要求 4.5.6所数返回值原则 6 46代码包规氾. …16 4.0.1代包的版不号 .l6 4.6.2代码包的标识 6 4.7代码控制 4.7.1代码年月录的建 4.7.2代码归档 附件1:数据类型缩写表 附件2:搾件名缩写表 a、NET控件 1 8 、hml控件 c、 ADO NET控件 1目的 a)为了统一公司软件开发设计过程的编程规范 b)使开发人员能方便的理解每个目录、变量、控件、类、方法的意义; c)为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程 序编码规范; d)编码规范和约定必须能明显改善代码可读性,并有助于代码管理; 2适应范围 本规范适用于企业所有基于NET平台的软件开发人员,作用于软什项日开 发的代码编写阶段和后期维护阶段 3术语及缩略语 4规范内容 41命名总体规则 )名字应该能够标识事物的特性。 b)名字一律使用英文单词,而不能为拼音。 c)名字尽量不使用缩写,除非它是众所周知的。 d)名字可以有两个或三个单词组成,但不应多于三个,控制在3至30个 字母以内。 e)在名字中,多个单词用大写第一个字丹(其它字母小写)来分隔。例如: SuPerusEr f)名字尽量使用前缀而不是后缀。 g)名宇中的单词尽量使用名词,如有动词,也尽量放在后面。例如: Functionuserdelete(前不是 FunctionDeleteuser)。 42命名规范 421变量命名 1、程序文件(*cs中的变量命名 程序中变量名称变量的前缀+代表变量含意的英文单词或单词缩写 类模块级的变量请用“m”+数据类型缩写作为前缀(其中,m,为“ module” 缩写,数据类型缩写见附件中的《数据类型缩写表》)。 public class Hello private string m strName private dataTable m dtbltable 类的属性所对应的交量,采用属性名前加“m”+类型缩写—前缀的形式 public class Hello private string m strName private DataTable m dtblTable public string Name get return m strName 过程级的变量使用类型缩写前缀 ay string strAy Word; 过程的参数使用“p”+类型缩写作为前缀(其中,p为“ parameter”缩 void Say(string pStrSay Word) tr Say Word 补充说明: 针对异常捕获过程中的 Exception变量命名,在没有冲突的情况下,统一命 名为ex; 如果有冲突的情况下,可以用“ex”+标志名称,如:exSq1。 try /代码 catch(Exception ex) //代码 补充:如果捕获异常不需要作任何处理,则不需要定义 Exception实例。 例 tr )代码 catch 鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以 简化它们的阅读。每个单词的第一个字丹都是大写 即使对于可能仪出现在几个代码行中的生存期很短的变量,仍然使用有意义 的名称。仅对于短循环索引使用单字母变量名,如i或j 在变量名中使用补对,如min/max、 begin/end和open/ close 不要使用原义数字或原义字符串,如For(i-1;i<-7;i+)。而是使用命 名常数,如For(i=1;i<= NUM DAYS IN WEEK;i++)以便于维护和理解。 2、控件命名 控件命名=控件缩写前缀+[“”]+名称;如: Datagrid dg Userlist或 userlist 422常量命名 常量名也应当有定的意义,格式为NOUN或NOUNⅤERB。常量名均 为大写,宇之间用下划线分隔。例: private const bool WEB ENABLEPAGECACHE DEFAULT- true private const int WEB PAGECACHEEXPIRESINSECONDS DEFAULT -3600 private const bool WEB E\ABLESSL DEfaULT= false 注:变量名和常量名最多可以包含255个字符,但是,超过25到30个 字符的名称比较笨拙。此外,要想取一个有实际意义的名称,清楚地表达变量或 常量的用途,25或30个字符应当足够了。 423类a9命名 a)名字应该能够标识事物的特性。 b)名字尽量不使用缩写,除非它是众所周知的。 c)名字可以有两个或三个单词组成,但通常不应多于三个。 d)在名字中,所有单词第一个字母大写。例如 SuPerusEr,包含I的,m可 以全部大写,如 Customer。 e)使用名词或名词短语命名类。 f)少用缩写。 g)不要使用下划线字符(。 b5]: public class FileStream public class Button public class string 424接口( Interface)命名 和类命名规范相同,唯一区别是接口在名字前加上“T前缀。例 interface IMap: EX interface IMap Document 42.方法( Method)命名 和类命名规范相同 426命名空间( Name Space)命名 和类命名规范相同 427属性( Property)命名 和类命名规范相同 4.3注释规范 431概述 a)注释要求英文及英文的标点符号。 b)注释屮,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描 述 c)每行注释的最大长度为100个字符 d)将注释与注释分隔符用个空格分开。 e)不允许给注释加外框。 f)编码的同时书写注释。 g)重要变量必须有注释。 h)变量注释和变量在同一行,所有注释必须对齐,与变量分开全少个“空格” 键。 L: int m iLevel, m iCount; //m iLevel. tree level l/m iCount.. count of tree items string m strSql;〃SQL )典型算法必须有注释。 j)在循环和逻辑分攴地方的上行必须就近书写注释。 k)程序段或语句的注释在程序段或语句的上行 l)在代码交付之前,必须删掉临时的或无关的注释 m)为便于阅读代码,每行代码的长度应少于100个字符。 432自建代码文件注释 对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释 水水木水水水水水水水木水水水水水水水水水六水水水水水水水水水水木水水水木水水小水水水水木水水水木木水 FileName Copyright(c)2004-xxx**米*米公司技术开发部 Writer. Create Date Rewriter Rewrite date Impact Main Content( Function Name, parameters\ returns 本;农尜水本冰水水本水本冰水水本本本冰水木本本本本本冰本水木本本小冰小本水凇*水 43.3模块(类注释 模块开始必须以以下形式书写模块注释: <summary // Module id:<模块编号,可以引用系统设计中的模块编号〉 // Depiction:<对此类的描述,可以引用系统设计中的描述〉 // Author:作者屮文名 / Create date:<模块创建日期,格式:Y-MMD ////summary> 如果模块只进行部分少量代码的修改吋,则每次修改须添加以下注释: // Rewriter date:<修改日期:格式YYYY-M-DD> Start1: /*原代码内容* ///End1 将原代码内容注释掉,然后添加新代码使用以下注释: // Added by add date:<添加日期,格式: YYYY-MM-DD> Start2: ///End2 如果模块输入输岀参薮或功能结构有铰大修改,则每次修改必须添加以下注释: ///summary / Log ID:<Log编号,从1开始次增加> /// depiction:<对此修改的描述〉 // Writer:修改者中文名 /// Rewrite date:<模块修改日期,格式:YYY-M-D> ///</summary> 434类属性注释 在类的属性必须以以卜格式编写属性注释: ///<summary> ///描述信息 ///</summary> 43.5方法注释 在类的方法声明前必须以以下格式编写注释 ///<summary> // depiction:<对该方法的说明〉 ///</summary> //< param name="<参数名称〉>参数说明></ param // returns> //<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义> ///</returns // Writer:作者中文名 // Create Date:<方法创建口期,格式:YYY-MM-DD

...展开详情
试读 20P C# 代码编写规范
立即下载 低至0.43元/次 身份认证VIP会员低至7折
    一个资源只可评论一次,评论内容不能少于5个字
    成功的失败家 很好的文档,感谢分享
    2018-11-16
    回复
    wplsyc986 非常不错,谢谢!
    2018-04-20
    回复
    倒大霉的上帝 感谢分享!
    2018-03-30
    回复
    kira_c4 很不错,很有用
    2013-12-02
    回复
    • 分享宗师

      成功上传21个资源即可获取
    关注 私信 TA的资源
    上传资源赚积分,得勋章
    最新推荐
    C# 代码编写规范 9积分/C币 立即下载
    1/20
    C# 代码编写规范第1页
    C# 代码编写规范第2页
    C# 代码编写规范第3页
    C# 代码编写规范第4页
    C# 代码编写规范第5页
    C# 代码编写规范第6页

    试读已结束,剩余14页未读...

    9积分/C币 立即下载 >