软件编码规范 a0 qj[+
前言: F;
0Dp
h ;jsH!
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 nE4l0[_
x7Eeb!s0f,
软件编码要遵循以下原则: eZ[#+0J
1.遵循开发流程,在设计的指导下进行代码编写。 _4O[[~
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 ,~iFEaV+
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 N4tc V\O
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 [&fWF~D-p<
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 $*g{[&L|6
6.占用资源少,以低代价完成任务。 ddl3fl#f
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 b\H/-7<
Y*"<@?n8?x
本规范的描述主要以 Borland C++ Builder 语言为例 rC=f#YjR
@i;L Za
一、 规范:以下对本规范作详细说明。 Af$0 o=".
G6f%/m`
1:源程序的文件管理: -0/=k_q_
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 ^BQ>vI'.4
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h 9.^-us1
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 zR_9D}
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 [Q7`RB
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 A7mMgb_
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 1i ?gvzrq
举例说明: PsacXZNs\N
/************************************************************* Z8N@e<!*~8
类:class TimageManipulation @fUX)zm>
设计者:wind (2001/05/09) K%o6hBlk_
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 g4?Q.'dZr
iLc)"L-i
版本: f'8B[&@L
1.0 2001/05/09 完成基本的图象处理功能设计 }S1Z>ZA5
2001/05/10 修改完成一个小Bug. _gis+f/8h
*************************************************************/ "'Q$.sR
class TImageManipulation bL6L-S
{ {b\Y?t^>f
private://define variant R;5QD`
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 3uB=L7.
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 WMt&8W5
//图像处理过程中的相关参数 ~7F EY0 /
int iBrightness; //色彩亮度 P*?d6v,r
int iContrast; //色彩对比度 T9&,v<f
int iRedColorBalance; //红色色彩平衡度 zzDNWPzsA
int iBlueColorBalance; //蓝色色彩平衡度 e)fJd*P
int iGreenColorBalance; //绿色色彩平衡度 A?%XO
%
bool bRotate; //字体旋转度数 TW;|G'}$
bool bMonochrome; //是否反白显示 `Pz!SJ|
private: 5pN08+
void __fastcall BrightnessImage(void);//调整图象亮度 Off: ~
void __fastcall ContrastImage(void);//调整图象对比度 E1mI Xd;.
void __fastcall DoManipulationImage(void);//图象处理 BZnp
#}f
void __fastcall MonochromeImage(void);//图象反白 N>uZ t2
void __fastcall DoColor(void); b7F3]W<`&