c代码编写规范标准.doc

word
word
1 / 42
word
代码编写规X(C#+数据库)



概述3
自建代码文件注释3
模块〔类〕注释4
类属性注释5
方法注释5
代码间注释5
4命名总体规如此5
5命名规X6
变量〔Variable〕命名6
常量命名8
类〔Class〕命名8
接口〔Interface〕命名8
方法〔Method〕命名8
命名空间〔NameSpace〕命名9
word
word
2 / 42
word
6编码规如此9
错误检查规如此9
大括号规如此9
缩进规如此9
小括号规如此10
else规如此10
比拟规如此10
规如此10
对齐规如此10
单语句规如此11
单一功能规如此11
简单功能规如此11
明确条件规如此11
选用false规如此11
独立赋值规如此11
定义常量规如此12
模块化规如此12
交流规如此12
7编程准如此12
变量使用12
数据库操作12
word
word
3 / 42
word
对象使用12
模块设计原如此12
结构化要求13
函数返回值原如此13
8代码包规X13
 代码包的版本号13
代码包的标识14
9代码的控制14
代码库/目录的建立14
代码归档15
10输入控制校验规如此15
登陆控制15
数据录入控制15
11数据库命名规如此15
11．1 数据库表15
11．2 表字段16
11．3 索引16
11．4 关联16
word
word
4 / 42
word
11．5 储存过程16
附：变量命名规X16
附： 2003控件命名规X17
附： 2005控件命名规X18
目的
为了统一公司软件开发的设计过程中关于代码编写时的编写规X和具体开发工作时的编程规X，保证代码的一致性，便于交流和维护，特制定此规X。
X围
本规X适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。
注释规X
概述
a)  注释中，应标明对象的完整的名称与其用途，但应防止对代码过于详细的描述。
word
word
5 / 42
word
b) 每行注释的最大长度为100个字符。
c) 将注释与注释分隔符用一个空格分开。
d) 不允许给注释加外框。
e) 编码的同时书写注释。
f) 重要变量必须有注释。
g)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab〞键。
如：int  iLevel,iCount;     // iLevel ....tree level
                                    // iCount ....count of tree items
    string strSql;            //SQL
h) 典型算法必须有注释。
i) 在循环和逻辑分支地方的上行必须就近书写注释。
j)程序段或语句的注释在程序段或语句的上一行
k) 在代码交付之前，必须删掉临时的或无关的注释。
l)为便于阅读代码，每行代码的长度应少于100个字符。
自建代码文件注释
对于自己创建的代码文件〔如函数、脚本〕，在文件开头，一般编写如下注释：
/******************************************************   
word
word
6 / 42
word
FileName:
Copyright  (c)  2004-xxxx *********公司技术开发部
Writer:
Create Date:
Rewriter:
Rewrite Date:
Impact:
Main Content〔Function Name、parameters、returns〕
              ******************************************************/
 
模块〔类〕注释
模块开始必须以以下形式书写模块注释：
///<summary>
///Module ID：<模块编号，可以引用系统设计中的模块编号>
///Depiction：<对此类的描述，可以引用系统设计中的描述>
///Author：作者中文名
word
word
7 / 42
word
///Create Date：<模块创建日期，格式：YYYY-MM-DD>
///</summary>
 
 
如