文档介绍：代码规则&SVN
马明
******@imu.
2013年3月
Transitional Page
程序代码编写规则
1. 程序风格
严格采用阶梯层次组织程序代码:
各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。要求相匹配的大括号在同一列,对继行则要求再缩进4格。例如:
void main()
{
long lI; //循环变量
long lSum;//用来记录和
float fAvg;//用来求平均值
......
//对数进行累加。
for( lI=0;lI<10;lI++)
{
lSum=lSum+lI;
}
//求平均值。
fAvg=lSum/;
}
1. 程序风格
提示信息字符串的位置
在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。
Eg.: printf(“无法打开文件!\n”);
=> printf(msg[FAILED_TO_OPEN_FILE]);
char *msg[]={“…”, “…”,…,};
对变量的定义,尽量位于函数的开始位置。
匈牙利命名法
匈牙利命名法是一种编程时的命名规范。
基本原则是:变量名=属性+类型+对象描述,
其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。
命名要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。
2. 命名规则
变量名的命名规则
变量的命名规则要求用“匈牙利法则”。
即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。
即: 变量名=变量类型+变量的英文意思(或缩写)
Eg.: long(LONG)      用l开头    lSum
对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。
2. 命名规则
指针变量命名的基本原则为:
“p”+变量类型前缀+命名
Eg.:如一个float*型应该表示为pfStat
全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写)
静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即: 变量名=s_+变量类型+变量的英文意思(或缩写)
成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写)
2. 命名规则
对struct、union、class变量的命名要求定义的类型用大写。并要加上前缀,其内部变量的命名规则与变量命名规则一致。
类一般用C开头
Eg.:
mFPoint
{
public:
float fPoint;
};
3. 注释规范
文件的注释
文件应该在文件开头加入以下注释:
/////////////////////////////////////////////////////////////////////
// 文件名:
//    工程:  文件所在的项目名。
//    作者:**,修改者:**
//    描述:说明文件的功能。
//    版本: 说明文件的版本,完成日期。
//    修改: 说明对文件的修改内容、修改原因以及修改日期。
/////////////////////////////////////////////////////////////////////
3. 注释规范
函数头的注释
对于函数,应该从“功能”,“参数”,“返回值”、3个方面用如下格式注释:
//===============================//
// 函数名(……)
//  功能:  从一个String 中删除另一个String。
//  参数:  strByDelete,strToDelete
//  (入口) strByDelete:  被删除的字符串(原来的字符串)
//  (出口) strToDelete:  要从上个字符串中删除的字符串。
//  返回: 找到并删除返回1,否则返回0。
//===============================//
函数名(……)