C#代码编写规范

《C#代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、C#代码编写规范目录目录1目的21目的32适应范围33术语及缩略语44规范内容44.1命名总体规则44.2命名规范44.2.1变量命名44.2.2常量命名64.2.3类(Class)命名64.2.4接口(Interface)命名74.2.5方法(Method)命名74.2.6命名空间(NameSpace)命名74.2.7属性(Property)命名74.3注释规范74.3.1概述74.3.2自建代码文件注释84.3.3模块(类)注释94.3.4类属性注释94.3.5方法注释104.3.6代码间注释104.4编码规则104.4.1

2、错误检查规则104.4.2大括号规则114.4.3小括号规则114.4.4缩进规则114.4.5对齐规则114.4.6比较规则114.4.7Case规则124.4.8If…Else规则124.4.9单语句规则124.4.10单一功能准则124.4.11简单功能准则124.4.12明确条件规则124.4.13选用False规则134.4.14独立赋值规则134.4.15定义常量规则134.4.16模块化规则134.4.17交流规则134.5编程准则144.5.1变量使用144.5.2数据库操作144.5.3对象使用144.5.4模

3、块设计原则144.5.5结构化要求144.5.6函数返回值原则154.6代码包规范154.6.1代码包的版本号154.6.2代码包的标识164.7代码控制174.7.1代码库/目录的建立174.7.2代码归档17附件1：数据类型缩写表17附件2：控件名缩写表18a、.NET控件18b、html控件19c、ADO.NET控件201目的a)为了统一公司软件开发设计过程的编程规范；b)使开发人员能方便的理解每个目录、变量、控件、类、方法的意义；c)为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范；d)编码规

4、范和约定必须能明显改善代码可读性，并有助于代码管理；2适应范围本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3术语及缩略语4规范内容4.1命名总体规则a)名字应该能够标识事物的特性。b)名字一律使用英文单词，而不能为拼音。c)名字尽量不使用缩写，除非它是众所周知的。d)名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。e)在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。f)名字尽量使用前缀而不是后缀。g)名字中的单

5、词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。4.2命名规范4.2.1变量命名1、 程序文件(*.cs)中的变量命名程序中变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。类模块级的变量请用“m_”+数据类型缩写作为前缀（其中，mØ为“module”缩写，数据类型缩写见附件中的《数据类型缩写表》）。publicclassHello{privatestringm_strName;privateDataTablem_dtblTable;}类的

6、属性所对应的变量，采用属性名前加“m_”+类型缩写Ø前缀的形式publicclassHello{privatestringm_strName;privateDataTablem_dtblTable;publicstringName{get{returnm_strName;}}}过程级的变量使用类型缩写前缀voidSay(){stringstrSayWord;}过程的参数使用“p_”+类型缩写作为前缀（其中，p为“parameter”缩写）voidSay(stringpStrSayWord){stringstrSayWord;}补

7、充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为ex；如果有冲突的情况下，可以用“ex”+标志名称，如：exSql。try{//代码}catch(Exceptionex){//代码}补充：如果捕获异常不需要作任何处理，则不需要定义Exception实例。例：try{//代码}catch{}鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。每个单词的第一个字母都是大写.即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用

8、单字母变量名，如i或j。在变量名中使用互补对，如min/max、begin/end和open/close。不要使用原义数字或原义字符串，如For(i=1;i<=7;i++)。而是使用命名常数，如For(i=1;i<=NUM_DAYS_IN_WEEK;i++)以便