软件编码规范 -0A@38, }
前言: R!sNg
"AT&!t[J
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 <$"7~i/X
lKf Mp1
软件编码要遵循以下原则: *}+R{
1.遵循开发流程,在设计的指导下进行代码编写。 FpP\-+Sl
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 ,)Yao;Cvd
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 5?^]1P_
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 '"Bex`
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 =ft9T&ciD
6.占用资源少,以低代价完成任务。 \V._Z>]
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 9 1BY]N
`ffj8U
本规范的描述主要以 Borland C++ Builder 语言为例 Z$Z`@&U=
2}D,df'W4
一、 规范:以下对本规范作详细说明。 ].LJt['%8
f&K}IM8& #
1:源程序的文件管理: Q]!6uA$A
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 |__d 8a
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h OMl8 a B9
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 #X4LLS]VV
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 a a4$'8s
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 !&Z*yH
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 uRP
Ff77
举例说明: O\%j56Bf
/************************************************************* X
d!Cp
类:class TimageManipulation Gj6<s./
设计者:wind (2001/05/09) X )I/%{
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 3QH(4N
_\p`4-.V
版本: /#29Y^Z)=
1.0 2001/05/09 完成基本的图象处理功能设计
wtlB
2001/05/10 修改完成一个小Bug. [70Y,,w
*************************************************************/ wbBE@RU>!
class TImageManipulation C2NzP & FD
{ {>S4#^@}
private://define variant ldP3n:7FS
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 [qSQ#Qzi2i
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 k9cK bf@
//图像处理过程中的相关参数 $$42pb.
int iBrightness; //色彩亮度 eDuX"/kHA
int iContrast; //色彩对比度 Bhj:9%`
int iRedColorBalance; //红色色彩平衡度 *8/VSs
int iBlueColorBalance; //蓝色色彩平衡度 e "_&z#
2_
int iGreenColorBalance; //绿色色彩平衡度 X#VEA=4{
bool bRotate; //字体旋转度数 A5+q^t}
bool bMonochrome; //是否反白显示 ;.\g-`jb
private: r8sdzz%
void __fastcall BrightnessImage(void);//调整图象亮度 q5!0\o:
void __fastcall ContrastImage(void);//调整图象对比度 /\~l1.6`
void __fastcall DoManipulationImage(void);//图象处理 R;%^j=Q
void __fastcall MonochromeImage(void);//图象反白 NOV.Bs{
yL
void __fastcall DoColor(void); 8:~b
&>
void __fastcall DoFilter(int * flt, int Div); miPmpu!
void __fastcall RotateImage(void);//调整图象色彩平衡 8`a,D5U:
S3; lKr
public://define property ,method,event,function \{lE0j7}h
__fastcall TImageManipulation(); hX&-/fF+f
__fastcall ~TImageManipulation(); #0(fOHPQ
<8$Md4r
void __fastcall DoBrightness(int BrightnessIncrement); qv.n9 9?]
void __fastcall DoContrast(int ContrastIncrement); 0"4J"q]&
void __fastcall DoMonochrome(void); D$ ej+s7
void __fastcall DoChangeColorBalance(int RedBalance, OqtQA#uL
int BlueBalance, int GreenBalance); )q^(T1
void __fastcall SetSourceImage(Classes::TPersistent* Source); 0Qt~K#mr/
Graphics::TBitmap * __fastcall GetManipulationImage(void); iW'_R{)T
void __fastcall DoBlur(void); #T[%6(QW
void __fastcall DoSharp(void); L+7*NaPY*
void __fastcall DoEmboss(void); )mj<{Td`
void __fastcall LoadImageFromFile(AnsiString FileName); l4zw]AYk+X
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); ,eDu$8J9
TImageManipulation& operator=(const TImageManipulation & imSource); <H!O:Mf_p
void __fastcall DoRotate(void); ~bWhth2*
}; JXL'\De ;
#endif m!;G/s*
;>5,
2.编辑风格: ,|A{!j`
$<:'!#%
(1)缩进 vpi l$Uq
&