C#项目代码书写规范说明1476.pdf

代码编写规范说明书（c#.net 与 ） 目录 代码编写规范说明书（c#.net 与 ） 1 1 目的3 2 范围3 3 注释规范3 3.1 概述3 3.2 自建代码文件注释4 3.3 模块（类）注释4 3.4 类属性注释5 3.5 方法注释5 3.6 代码间注释5 4 命名总体规则6 5 命名规范6 5.1 变量（Variable ）命名6 5.2 常量命名8 5.3 类（Class ）命名9 5.4 接口（Interface ）命名9 5.5 方法（Method ）命名9 5.6 命名空间（NameSpace ）命名9 6 编码规则 10 6.1 错误检查规则 10 6.2 大括号规则 10 6.3 缩进规则 10 6.4 小括号规则 10 6.5 If Then Else 规则 11 6.6 比较规则 11 6.7 Case 规则 11 6.8 对齐规则 11 6.9 单语句规则 12 6.10 单一功能规则 12 1 / 20 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 模块设计原则 14 7.5 结构化要求 14 7.6 函数返回值原则 14 8 代码包规范 15 8.1 代码包的版本号 15 8.2 代码包的标识 15 9 代码的控制 16 9.1 代码库/ 目录的建立 16 9.2 代码归档 16 10 输入控制校验规则 16 10.1 登陆控制 16 10.2 数据录入控制 16 11. 数据库命名规范: 17 附件1：数据类型缩写表 17 附件2 ：服务器控件名缩写表 18 2 / 20 1 目的 （1）为了统一公司软件开发设计过程的编程规范 （2 ）使参与项目开发人员能很方便的理解每个目录,变量，控件，类，方法的意义 （3 ）为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编 码规范。 （4 ）编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用 于企业所有基于.NET 平台的软件开发工作 2 范围 本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。 3 注释规范 3.1 概述 a) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。 b) 每行注释的最大长度为100 个字符。 c) 将注释与注释分隔符用一个空格分开。 d) 不允许给注释加外框。 e) 编码的同时书写注释。 f) 重要变量必须有注释。 g) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。 如：int m_iLevel,m_iCount; // m_iLevel tree level // m