软件编码规范 8c5YX
前言: K6DN>0sY
9KVJk</:n
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 ]BO:*&O
G)amng/
软件编码要遵循以下原则: sS-dHa
1.遵循开发流程,在设计的指导下进行代码编写。 "B QnP9
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 nCY kUDnZ
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 x9YQd69
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 $toTMah
w
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 qFm w9\Fn
6.占用资源少,以低代价完成任务。 )]@h}K}
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 Im;%.J
;e?M;-
本规范的描述主要以 Borland C++ Builder 语言为例 ?[JP[
qS
J*;RL`
一、 规范:以下对本规范作详细说明。 nH#>_R
(
C hF~
1:源程序的文件管理: Y-ao
yoNS
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 5%jhVys23
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h <YyE1|
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 (%6fMVp
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 |nNcV~%~
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 Sf?;j{?G
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 Vuz.b.,i`
举例说明: R*r4)+gd
/************************************************************* UF+Qx/4h0
类:class TimageManipulation 2>o[
设计者:wind (2001/05/09) *2h%dT:,%
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 G4(R/<J,BQ
?Bf>G]zx
版本: Yc[umn^K
1.0 2001/05/09 完成基本的图象处理功能设计 `w!XO$"]Z
2001/05/10 修改完成一个小Bug. c5ij2X|I
*************************************************************/ Y5aG^wE[:
class TImageManipulation JI>Y?1i0O
{ $cSUB
private://define variant }a;xs};X;
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 R1zt6oY
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 #Y=^4 U`
//图像处理过程中的相关参数 4aHogheg
int iBrightness; //色彩亮度 neFwxS?
int iContrast; //色彩对比度 oxxuw
Dcl
int iRedColorBalance; //红色色彩平衡度 bv4umL /
int iBlueColorBalance; //蓝色色彩平衡度 ^L%_kL_7
int iGreenColorBalance; //绿色色彩平衡度 t\,Y<9{w
bool bRotate; //字体旋转度数 n{gEIUo#
bool bMonochrome; //是否反白显示 q%sZV>
private: lE k@I"
void __fastcall BrightnessImage(void);//调整图象亮度 9L>?N:%5
void __fastcall ContrastImage(void);//调整图象对比度 COw"6czX/
void __fastcall DoManipulationImage(void);//图象处理 T8+[R2_
void __fastcall MonochromeImage(void);//图象反白 i.E2a)
void __fastcall DoColor(void); %axr@o[
void __fastcall DoFilter(int * flt, int Div); x_Ev2
c'4
void __fastcall RotateImage(void);//调整图象色彩平衡 6=f)3!=
>+{WiZ`
public://define property ,method,event,function Ksx-Y"
__fastcall TImageManipulation(); =mYf]
PIX
__fastcall ~TImageManipulation(); xSudDhRP
Xl4}S"a
void __fastcall DoBrightness(int BrightnessIncrement); cKVFykwM
void __fastcall DoContrast(int ContrastIncrement); e\6H.9=
void __fastcall DoMonochrome(void); ^*AI19w!Ys
void __fastcall DoChangeColorBalance(int RedBalance, U<'N=#A
J
int BlueBalance, int GreenBalance); {T8;-H0H
void __fastcall SetSourceImage(Classes::TPersistent* Source); SW9
C
8Q
Graphics::TBitmap * __fastcall GetManipulationImage(void); {b!{~q
void __fastcall DoBlur(void); YdhV
a!Y
void __fastcall DoSharp(void); <@Q27oEuA
void __fastcall DoEmboss(void); d]0:r]e
void __fastcall LoadImageFromFile(AnsiString FileName); w;,34qbf
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); )Q=u[ p
TImageManipulation& operator=(const TImageManipulation & imSource); ov+{<0Q
void __fastcall DoRotate(void); Wep^He\:
}; $M}"u[Qq
#endif AMyg>n!
Y#os6|MV#
2.编辑风格: vm@V5oH
) ^En
(1)缩进 rD}g9?ut
T
6D+@i
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 boojq{cvYA
3H,x4L5j
(2)空格 `Abd=1nH
LGhK)]:
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 x'L=p01
5len}){
(3)对齐 )^(gwE
*tv&