C#代码编写规范标准.doc

《C#代码编写规范标准.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、代码编写规范(C#+数据库)1.目的32.范围33.注释规范33.1概述33.2自建代码文件注释33.3模块（类）注释43.4类属性注释53.5方法注释53.6代码间注释54命名总体规则55命名规范65.1变量（Variable）命名65.2常量命名85.3类（Class）命名85.4接口（Interface）命名85.5方法（Method）命名85.6命名空间（NameSpace）命名96编码规则96.1错误检查规则96.2大括号规则96.3缩进规则96.4小括号规则106.5ifelse规则106.6比较规

2、则106.7case规则106.8对齐规则106.9单语句规则116.10单一功能规则116.11简单功能规则116.12明确条件规则116.13选用false规则116.14独立赋值规则116.15定义常量规则126.16模块化规则126.17交流规则127编程准则127.1变量使用127.2数据库操作127.3对象使用127.4模块设计原则127.5结构化要求137.6函数返回值原则138代码包规范138.1 代码包的版本号138.2代码包的标识149代码的控制149.1代码库/目录的建立149.2代码归档

3、1510输入控制校验规则1510.1登陆控制1510.2数据录入控制1511数据库命名规则1511．1数据库表1511．2表字段1611．3索引1611．4关联1611．5储存过程16附：变量命名规范16附：VS.NET2003控件命名规范17附：VS.NET2005控件命名规范181.目的为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。2.范围本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3.注释

4、规范3.1概述a) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。b) 每行注释的最大长度为100个字符。c) 将注释与注释分隔符用一个空格分开。d) 不允许给注释加外框。e) 编码的同时书写注释。f) 重要变量必须有注释。g)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。如：int iLevel,iCount;    //iLevel....treelevel                                   //iCount....cou

5、ntoftreeitems   stringstrSql;           //SQLh) 典型算法必须有注释。i) 在循环和逻辑分支地方的上行必须就近书写注释。j)程序段或语句的注释在程序段或语句的上一行k) 在代码交付之前，必须删掉临时的或无关的注释。l)为便于阅读代码，每行代码的长度应少于100个字符。1.1自建代码文件注释对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：/******************************************************

6、   FileName:Copyright (c) 2004-xxxx*********公司技术开发部Writer:CreateDate:Rewriter:RewriteDate:Impact:MainContent（FunctionName、parameters、returns）             ******************************************************/ 1.1模块（类）注释模块开始必须以以下形式书写模块注释：///

8、      将原代码内容注释掉，然后添加新代码使用以下注释：///Addedby： Adddate：<添加日期，格式：YYYY-MM-DD>  Start2：       新代码内容///End2：                                  如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：///