软件编码规范 Fzu"&&>0$
前言: qx_+mCZ
l[\[)X3$
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 0dIJgKanGP
|&RdOjw$u
软件编码要遵循以下原则: ,3fw"P$
1.遵循开发流程,在设计的指导下进行代码编写。 m?<C\&)6x
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 |dX#4Mq^,
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 FpW{=4yk
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 L]HY*e
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 @*%.V.
6.占用资源少,以低代价完成任务。 ^{~y+1lt'
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 3)Paf`mr
TC R(
本规范的描述主要以 Borland C++ Builder 语言为例 H.i_,ZF
?FMHK\
一、 规范:以下对本规范作详细说明。 KY|Q#i|pM
[xI@)5Xk
1:源程序的文件管理: .`)ICX
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 ||L qx#e=
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h y\x!Be;6Z.
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 cHJ
&a`;
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 M5%u>$2
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 M6 0(yTm
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 kv(N/G
举例说明: /1MO]u\
/************************************************************* -u{k
类:class TimageManipulation 7qzI]
设计者:wind (2001/05/09) [IV8
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 &NGlkn
@.CPZT
版本: `86 9XE
1.0 2001/05/09 完成基本的图象处理功能设计 `?Y/:4
2001/05/10 修改完成一个小Bug. O 6A:0yM4
*************************************************************/ eU{=x$o6S
class TImageManipulation ]Ff&zBJ
{ .}CPZ3y
private://define variant ;TaT=%
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 8Cm^#S,+
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 {W0]0_mI(
//图像处理过程中的相关参数 %
;6e@U}
int iBrightness; //色彩亮度 yiI&>J))
int iContrast; //色彩对比度 qvYw[D#.
int iRedColorBalance; //红色色彩平衡度 !T
@|9PCp
int iBlueColorBalance; //蓝色色彩平衡度 :5CwRg
int iGreenColorBalance; //绿色色彩平衡度 M>T#MDK\(
bool bRotate; //字体旋转度数 Gm>8=
=c
bool bMonochrome; //是否反白显示 Bxm^Arc>
private: elP`5BuN
void __fastcall BrightnessImage(void);//调整图象亮度 40q8,M
void __fastcall ContrastImage(void);//调整图象对比度 U 2\{(y
void __fastcall DoManipulationImage(void);//图象处理 ^PWZ1.T
void __fastcall MonochromeImage(void);//图象反白 ;o8cfD .z
void __fastcall DoColor(void); Xb;CY9&
void __fastcall DoFilter(int * flt, int Div); zo]7#
void __fastcall RotateImage(void);//调整图象色彩平衡 /{qr~7k,oQ
{}lw%d?A
public://define property ,method,event,function YTYYb#"Q
__fastcall TImageManipulation(); 2@^8{
__fastcall ~TImageManipulation(); '-ACNgNn
dks0
void __fastcall DoBrightness(int BrightnessIncrement); QZ{:#iuig
void __fastcall DoContrast(int ContrastIncrement); L'['7
void __fastcall DoMonochrome(void); dmE-WS
void __fastcall DoChangeColorBalance(int RedBalance, W:0@m^r
int BlueBalance, int GreenBalance); f#^%\K:YYR
void __fastcall SetSourceImage(Classes::TPersistent* Source); M{z+=c&w
Graphics::TBitmap * __fastcall GetManipulationImage(void); *M KVm)Iv
void __fastcall DoBlur(void); YR[Ii?
void __fastcall DoSharp(void); ,L_p"A
void __fastcall DoEmboss(void); q+LjWZ+O
void __fastcall LoadImageFromFile(AnsiString FileName); JQbI^ef_;
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); +F67g00T|
TImageManipulation& operator=(const TImageManipulation & imSource); m0\(a_0V
void __fastcall DoRotate(void); qe\j$Cjy
}; 9`c :sop
#endif @rVmr{UE
$wX5`d1
2.编辑风格: ^s24f?3
l}<s~ip
(1)缩进 9prG@
F /t;y\)
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 o*dhks[
fT'A{&h|U
(2)空格 rU'&o) a^
7 H<_
wW
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 cJH7zumM)
(cA=~Bw[=
(3)对齐 S liF$}J
VDQ&BmJE
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 LU%g>?m.]
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: `D GO~RMp9
int Value; hr)TC-
int Result; !TG"AW
int Length; 1uD}V7_y"
DWORD Size; ZY][LU~l8
DWORD BufSize; fxiq,o0
char * pBuf; 1hRC
Bwx
void * pOutputBuf; \3Xt\1qN4
LPCSTR * pPath; b!UT<:o
{`1zVT p[<
(4)空行 [i&tE.7
lUWjm%|
程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行,由于BCB会自动产生一行“//------”做分隔,另因每个函数还要有函数说明注释,故通常只需空一行或不空,但对于没有函数说明的情况至少应再空一行。对自己写的函数,建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行。类中四个“p”之间至少空一行,在其中的数据与函数之间也应空行。 Q>z0?%B
k"L_0HK
(5)注释 SZyPl9.b
a_Xh(d$
对注释有以下三点要求: d5u,x.R
A.必须是有意义。 12k)Ek9
B.必须正确的描述了程序。 I:Z38xz -[
C.必须是最新的。 jp&