软件编码规范 T ?HG}(2
前言: /);S?7u.
h!yI(cY
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 B_ x?s
TAE@KSPvo
软件编码要遵循以下原则: _/\U
1.遵循开发流程,在设计的指导下进行代码编写。 [p:mja.6y
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 655OL)|cD6
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 mBtXa|PJ
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 -G|?Kl
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 gS
VWv9+
6.占用资源少,以低代价完成任务。 &N+i3l6`
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 iCZuE:I1K,
Q"(*SA+-|
本规范的描述主要以 Borland C++ Builder 语言为例 ' 5F3,/r
d~hN`ff
一、 规范:以下对本规范作详细说明。 s+fjQo4
WR<,[*Mv^
1:源程序的文件管理: $eSSW+8q"
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 G*y!
Q
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h kWZ@v+Mk3
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 *ydh.R<hb
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 :svKE.7{
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 D\@)*"
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 n)bbEXO
举例说明: ag*5fBF
/************************************************************* <Na .6P
类:class TimageManipulation Xus TU
设计者:wind (2001/05/09) g^mnYg5
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 fvNj5Vq:
W{l{O1,
版本: ZR[6-
1.0 2001/05/09 完成基本的图象处理功能设计 H'_ v
2001/05/10 修改完成一个小Bug. s9\N{ar#
*************************************************************/ *U}cj A:ZN
class TImageManipulation oQ{
X2\
{ tso\bxiU
private://define variant /hv2=A
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 C&/_mm5
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 .Z9{\tj
//图像处理过程中的相关参数 hf1h*x^J
int iBrightness; //色彩亮度 eelkK,4
int iContrast; //色彩对比度 PHh4ZFl]_I
int iRedColorBalance; //红色色彩平衡度 9cJ1J7y
int iBlueColorBalance; //蓝色色彩平衡度 tVr^1Y
int iGreenColorBalance; //绿色色彩平衡度 Evy_I+l
bool bRotate; //字体旋转度数 wpK[;
bool bMonochrome; //是否反白显示 /V"6Q'D
private: e9p!Caf~I-
void __fastcall BrightnessImage(void);//调整图象亮度 <KEVA?0>
void __fastcall ContrastImage(void);//调整图象对比度
%c-T Gr,
void __fastcall DoManipulationImage(void);//图象处理 fpA%:V
void __fastcall MonochromeImage(void);//图象反白 .:(T}\]R
void __fastcall DoColor(void); szw|`S>o
void __fastcall DoFilter(int * flt, int Div); 6BY(Y(z
void __fastcall RotateImage(void);//调整图象色彩平衡
oHR@*2b
(p!w`MSv
public://define property ,method,event,function m+ =L}[
__fastcall TImageManipulation(); `7$Sga6M
__fastcall ~TImageManipulation(); mFx\[S
+]$c+!khj
void __fastcall DoBrightness(int BrightnessIncrement); Y$<p_X,
void __fastcall DoContrast(int ContrastIncrement); 4V7=VZ,@3
void __fastcall DoMonochrome(void); o56UlN
void __fastcall DoChangeColorBalance(int RedBalance, SFkB,)Z N
int BlueBalance, int GreenBalance); Cb
i;CF\{
void __fastcall SetSourceImage(Classes::TPersistent* Source); EHF
dQ0gIa
Graphics::TBitmap * __fastcall GetManipulationImage(void); n?S~(4%
void __fastcall DoBlur(void); q!Q*T^-rO
void __fastcall DoSharp(void); .:9XpKbt
void __fastcall DoEmboss(void); ?atHZLF
void __fastcall LoadImageFromFile(AnsiString FileName); +&*Ybbhb
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); SG{&2G
TImageManipulation& operator=(const TImageManipulation & imSource); | h%0)_
void __fastcall DoRotate(void); t+IrQf,P[
}; `+]e}*7$f
#endif |,lw$k93
_BPp=(|
2.编辑风格: #``Alh8
[+(fN
(1)缩进 X(qs]:
W;^6=(&xn
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 z"$huE>P6
n,*E
s/\
(2)空格 N D1'XCN
}_,={<g
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 HzZ.q2Zz%
Jie=/:&
(3)对齐 7f]O /
AVi,+n
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 CQh6;[\:
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: 5.U4P<