C代码编写规范.doc

C#代码编写规范 目录 TOC \o 1-3 \h \z \u 目录1目的 2 1目的 3 2适应范围 3 3术语及缩略语 4 4规范内容 4 4.1命名总体规则 4 4.2命名规范 4 4.2.1变量命名 4 4.2.2常量命名 6 4.2.3类(Class)命名 6 4.2.4接口(Interface)命名 7 4.2.5方法(Method)命名 7 4.2.6命名空间(NameSpace)命名 7 4.2.7属性(Property)命名 7 4.3注释规范 7 4.3.1概述 7 4.3.2自建代码文件注释 8 4.3.3模块(类)注释 9 4.3.4类属性注释 9 4.3.5方法注释 10 4.3.6代码间注释 10 4.4编码规则 10 4.4.1错误检查规则 10 4.4.2大括号规则 11 4.4.3小括号规则 11 4.4.4缩进规则 11 4.4.5对齐规则 11 4.4.6比较规则 11 4.4.7 Case规则 12 4.4.8 If … Else规则 12 4.4.9单语句规则 12 4.4.10单一功能准则 12 4.4.11简单功能准则 12 4.4.12明确条件规则 12 4.4.13选用False规则 13 4.4.14独立赋值规则 13 4.4.15定义常量规则 13 4.4.16模块化规则 13 4.4.17交流规则 13 4.5编程准则 14 4.5.1变量使用 14 4.5.2数据库操作 14 4.5.3对象使用 14 4.5.4模块设计原则 14 4.5.5结构化要求 14 4.5.6函数返回值原则 15 4.6代码包规范 15 4.6.1代码包的版本号 15 4.6.2代码包的标识 16 4.7代码控制 17 4.7.1代码库/目录的建立 17 4.7.2代码归档 17 附件1：数据类型缩写表 17 附件2：控件名缩写表 18 a、.NET控件 18 b、html控件 19 c、ADO.NET控件 20 1目的 为了统一公司软件开发设计过程的编程规范； 使开发人员能方便的理解每个目录、变量、控件、类、方法的意义； 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范； 编码规范和约定必须能明显改善代码可读性，并有助于代码管理； 2适应范围 本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 3术语及缩略语 4规范内容 4.1命名总体规则 名字应该能够标识事物的特性。 名字一律使用英文单词，而不能为拼音。 名字尽量不使用缩写，除非它是众所周知的。 名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。 名字尽量使用前缀而不是后缀。 名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。 4.2命名规范 4.2.1变量命名 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; } } } 过程级的变量使用类型缩写前缀 void Say() {