分享
 
 
 

关于编程风格的讨论

王朝other·作者佚名  2008-06-01
窄屏简体版  字體: |||超大  

**软件公司软件开发规范

(试行版)

在公司团队协作开发的情况下,编程时应该强调的一个重要方面是程序的易读性,在保证软件的速度等性能指标能满足用户需求的情况下,能让其他程序员轻易读懂你的程序。一套鲜明的编程风格,可以让协作者、后继者和自己一目了然,在很短的时间内看清程序的结构,理解设计的思路。大大的提高代码的可读性、可重用性、程序健壮性、可移植性和可维护性。

制定本编程规范的目的是为了提高公司的软件开发效率及所开发的软件的可维护性,提高软件的质量。本规范由程序风格、命名规则、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。

一、程序风格:

1、严格采用阶梯层次组织程序代码:

各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。要求相匹配的大括号在同一列,对继行则要求再缩进4格。例如:

void main()

{

......

long lI; //循环变量

long lSum;//用来记录和

float fAvg;//用来求平均值

......

//对数进行累加。

for( lI=0;lI<10;lI++)

{

lSum=lSum+lI;

...... }

//求平均值。

fAvg=lSum/10.0;

......

}

2、提示信息字符串的位置

在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。

3、对变量的定义,尽量位于函数的开始位置。

二、命名规则:

1、变量名的命名规则

①、变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。

即: 变量名=变量类型+变量的英文意思(或缩写)

对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。

见下表:

bool(BOOL) 用b开头 bIsParent

byte(BYTE) 用by开头 byFlag

short(int) 用n开头 nStepCount

long(LONG) 用l开头 lSum

char(CHAR) 用c开头 cCount

float(FLOAT) 用f开头 fAvg

double(DOUBLE) 用d开头 dDeta

void(VOID) 用v开头 vVariant

unsigned short(Word) 用w开头 wCount

unsigned long(DWORD) 用dw开头 dwBroad

HANDLE(HINSTANCE) 用h开头 hHandle

DWORD 用dw开头 dwWord

LPCSTR(LPCTSTR) 用str开头 strString

用0结尾的字符串 用sz开头 szFileName

对未给出的变量类型要求提出并给出命名建议给技术委员会。

②、指针变量命名的基本原则为:

对一重指针变量的基本原则为:

“p”+变量类型前缀+命名

如一个float*型应该表示为pfStat

对多重指针变量的基本规则为:

二重指针: “pp”+变量类型前缀+命名

三重指针: “ppp”+变量类型前缀+命名

......

③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写)

④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即: 变量名=s_+变量类型+变量的英文意思(或缩写)

⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写)

⑥、对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。并且要求用大写。

如:enum cmEMDAYS

{

EMDAYS_MONDAY;

EMDAYS_TUESDAY;

……

};

⑦、对strUCt、union、class变量的命名要求定义的类型用大写。并要加上前缀,其内部变量的命名规则与变量命名规则一致。

结构一般用S开头

如:struct ScmNPoint

{

int nX;//点的X位置

int nY; //点的Y位置

};

联合体一般用U开头

如: union UcmLPoint

{

long lX;

long lY;

}

类一般用C开头

如:

class CcmFPoint

{

public:

float fPoint;

};

对一般的结构应该定义为类模板,为以后的扩展性考虑

如:

template <class TYPE>

class CcmTVector3d

{

public:

TYPE x,y,z;

};

⑧、对常量(包括错误的编码)命名,要求常量名用大写,常量名用英文表达其意思。

如:#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示类别。

⑨、对const 的变量要求在变量的命名规则前加入c_,即:c_+变量命名规则;例如:

const char* c_szFileName;

2、 函数的命名规范:

函数的命名应该尽量用英文表达出函数完成的功能。遵循动宾结构的命名法则,函数名中动词在前,并在命名前加入函数的前缀,函数名的长度不得少于8个字母。

例如:

long cmGetDeviceCount(……);

3、函数参数规范:

①、 参数名称的命名参照变量命名规范。

②、 为了提高程序的运行效率,减少参数占用的堆栈,传递大结构的参数,一律采用指针或引用方式传递。

③、 为了便于其他程序员识别某个指针参数是入口参数还是出口参数,同时便于编译器检查错误,应该在入口参数前加入const标志。如:

……cmCopyString(const char * c_szSource, char * szDest)

4、引出函数规范:

对于从动态库引出作为二次开发函数公开的函数,为了能与其他函数以及Windows的函数区分,采用类别前缀+基本命名规则的方法命名。例如:在对动态库中引出的一个图象编辑的函数定义为

imgFunctionname(其中img为image缩写)。

现给出三种库的命名前缀:

①、 对通用函数库,采用cm为前缀。

②、 对三维函数库,采用vr为前缀。

③、 对图象函数库,采用img为前缀。

对宏定义,结果代码用同样的前缀。

5、文件名(包括动态库、组件、控件、工程文件等)的命名规范:

文件名的命名要求表达出文件的内容,要求文件名的长度不得少于5个字母,严禁使用象file1,myfile之类的文件名。

三、注释规范:

1、函数头的注释

对于函数,应该从“功能”,“参数”,“返回值”、“主要思路”、“调用方法”、“日期”六个方面用如下格式注释:

//程序说明开始

//================================================================//

// 功能: 从一个String 中删除另一个String。

// 参数: strByDelete,strToDelete

// (入口) strByDelete: 被删除的字符串(原来的字符串)

// (出口) strToDelete: 要从上个字符串中删除的字符串。

// 返回: 找到并删除返回1,否则返回0。(对返回值有错误编码的要// 求列出错误编码)。

// 主要思路:本算法主要采用循环比较的方法来从strByDelete中找到

// 与strToDelete相匹配的字符串,对多匹配strByDelete

// 中有多个strToDelete子串)的情况没有处理。请参阅:

// 书名......

// 调用方法:......

// 日期:起始日期,如:2000/8/21.9:40--2000/8/23.21:45

//================================================================//

函数名(……)

//程序说明结束

①、

对于某些函数,其部分参数为传入值,而部分参数为传出值,所以对参数要具体说明该参数是入口参数,还是出口参数,对于某些意义不明确的参数还要做具体说明(例如:以角度作为参数时,要说明该角度参数是以弧度(PI),还是以度为单位),对既是入口又是出口的变量应该在入口和出口处同时标明。等等。

②、 函数的注释应该放置在函数的头文件中,在实现文件中的该函数的实现部分应该同时放置该注释。

③、 在注释中应该具体说明函数的主要实现思路、非凡要注明自己的一些想法,假如有必要则应该写明对想法产生的来由。对一些模拟的函数应该注释上函数的出处。

④、 在注释中具体注明函数的适当调用方法,对于返回值的处理方法等。在注释中要强调调用时的危险方面,可能出错的地方。

⑤、 对日期的注释要求记录从开始写函数到结束函数的测试之间的日期。

⑥、 对函数注释开始到函数命名之间应该有一组用来标识的非凡字符串。

假如算法比较复杂,或算法中的变量定义与位置有关,则要求对变量的定义进行图解。对难以理解的算法能图解尽量图解。

2、变量的注释:

对于变量的注释紧跟在变量的后面说明变量

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有