代码编写规范adonet.docVIP

代码编写规范（c#与asp.net） 2010-12-1 目录 1 目的 4 2 范围 4 3 注释规范 4 3.1 概述 4 3.2 自建代码文件注释 4 3.3 模块（类）注释 5 3.4 类属性注释 6 3.5 方法注释 6 3.6 代码间注释 6 4 命名总体规则 6 5 命名规范 7 5.1 变量（Variable）命名 7 5.2 常量命名 9 5.3 类（Class）命名 9 5.4 接口（Interface）命名 9 5.5 方法（Method）命名 9 5.6 命名空间（NameSpace）命名 10 6 编码规则 10 6.1 错误检查规则 10 6.2 大括号规则 10 6.3 缩进规则 10 6.4 小括号规则 11 6.5 If Then Else规则 11 6.6 比较规则 11 6.7 Case规则 11 6.8 对齐规则 11 6.9 单语句规则 12 6.10 单一功能规则 12 6.11 简单功能规则 12 6.12 明确条件规则 12 6.13 选用FALSE规则 12 6.14 独立赋值规则 12 6.15 定义常量规则 12 6.16 模块化规则 13 6.17 交流规则 13 7 编程准则 13 7.1 变量使用 13 7.2 数据库操作 13 7.3 对象使用 13 7.4 模块设计原则 13 7.5 结构化要求 14 7.6 函数返回值原则 14 8 代码包规范 14 8.1 代码包的版本号 14 8.2 代码包的标识 15 9 输入控制校验规则 15 9.1 登陆控制 15 9.2 数据录入控制 15 10 附件 16 10.1 数据类型 缩写 16 10.2 服务器控件名缩写表 16 10.2.1 web控件 16 10.2.2 html控件 17 10.2.3 ADO.NET控件命名规范 18  目的 为了统一公司软件开发设计过程的编程规范 使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 注释规范 概述 注释要求英文及英文的标点符号。 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 每行注释的最大长度为100个字符。 将注释与注释分隔符用一个空格分开。 不允许给注释加外框。 编码的同时书写注释。 重要变量必须有注释。 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。 如：int m_iLevel,m_iCount; // m_iLevel tree level // m_iCount count of tree items string m_strSql; //SQL 典型算法必须有注释。 在循环和逻辑分支地方的上行必须就近书写注释。 程序段或语句的注释在程序段或语句的上一行 在代码交付之前，必须删掉临时的或无关的注释。 为便于阅读代码，每行代码的长度应少于100个字符。 自建代码文件注释 对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释： 模块（类）注释 模块开始必须以以下形式书写模块注释： 如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释： 将原代码内容注释掉，然后添加新代码使用以下注释： 如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释： 类属性注释 在类的属性必须以以下格式编写属性注释： 方法注释 在类的方法声明前必须以以下格式编写注释 代码间注释 代码间注释分为单行注释和多行注释： //单行注释 /*多行注释1 多行注释2 多行注释3*/ 代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。 命名总体规则 名字应该能够标识事物的特性。 名字一律使用英文单词，而不能为拼音。 名字尽量不使用缩写，除非它是众所周知的。 名字可以有两个或三个单词组成，但不应多于三个，控制在3至30个字母以内。 在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。 名字尽量使用前缀而不是后缀。 名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。 命名规范 变量（Variable）命名 程序文件(*.cs)中的变量命名 程序中变量名称 = 变量的前缀 +代