软件编码规范 _ YcIGOL
前言: S^7u`-
303x|y
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 wqF_hs(O
~0YRWM ;
软件编码要遵循以下原则: `OHdo$Y9
1.遵循开发流程,在设计的指导下进行代码编写。 )5ev4Qf
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 2&0#'Tb
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。
+wE>h>?;
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 l:14uWu|
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 ZJ%iiY
6.占用资源少,以低代价完成任务。 0I}c|V'P
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 (L,>P`CR6
[u;>b?[{
本规范的描述主要以 Borland C++ Builder 语言为例 o(@^V!}V
V?r(; x
一、 规范:以下对本规范作详细说明。 {S"! c.
|!xqkmX
1:源程序的文件管理: gCZm7dgo
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 j|IvDrm#
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h I^?hVH
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 )rbcY0q
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 Os[50j!4>
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 UJ^-T+fut
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 T5+
(F z
举例说明: 9D
@}(t!
/************************************************************* \^Z DH
类:class TimageManipulation '=(@3ggA:
设计者:wind (2001/05/09) "rcV?5?v~
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 [g@.dr3t
|Li9Y"5
版本: yC9~X='D
1.0 2001/05/09 完成基本的图象处理功能设计 #RWmP$+#=
2001/05/10 修改完成一个小Bug. Jzj>=jWX@
*************************************************************/ c{\x<AwO
class TImageManipulation ;*>':-4
{ $sb `BS
private://define variant 2T-3rC)
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 ]Vd1fkXO0
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 8M6Qn7{L
//图像处理过程中的相关参数 N3&n"w _d
int iBrightness; //色彩亮度 ,H5o/qNU`{
int iContrast; //色彩对比度 wmaj[e,h
int iRedColorBalance; //红色色彩平衡度 QV_Ep8
int iBlueColorBalance; //蓝色色彩平衡度 _MzdbUb5,
int iGreenColorBalance; //绿色色彩平衡度 nT%<!/}!
bool bRotate; //字体旋转度数 s%@HchZ 1
bool bMonochrome; //是否反白显示 AxiCpAS;J
private: $j'8Z^
void __fastcall BrightnessImage(void);//调整图象亮度 BF(Kaf;<t.
void __fastcall ContrastImage(void);//调整图象对比度 PaBqv]
void __fastcall DoManipulationImage(void);//图象处理 dk@iAL*v
void __fastcall MonochromeImage(void);//图象反白 Rqun}v}
void __fastcall DoColor(void); s AlOX`t
void __fastcall DoFilter(int * flt, int Div); [OwrIL
void __fastcall RotateImage(void);//调整图象色彩平衡 d^G5Pq
V w5@)l*f
public://define property ,method,event,function 2VgVn,c
__fastcall TImageManipulation(); H 2UR
__fastcall ~TImageManipulation(); QUi=ZD1
c\N-B,m&
void __fastcall DoBrightness(int BrightnessIncrement); fR,7l9<%Zp
void __fastcall DoContrast(int ContrastIncrement); z{G@t0q
void __fastcall DoMonochrome(void); i&zJwUr(<
void __fastcall DoChangeColorBalance(int RedBalance, ufXU
int BlueBalance, int GreenBalance); 3R[,,WAj$
void __fastcall SetSourceImage(Classes::TPersistent* Source); (d}z>?L
Graphics::TBitmap * __fastcall GetManipulationImage(void); Q) Y&h'.(
void __fastcall DoBlur(void); <j^"=UN4#
void __fastcall DoSharp(void); @EGUQ|WL^
void __fastcall DoEmboss(void); LO;Z3Q>#0
void __fastcall LoadImageFromFile(AnsiString FileName); RLUH[[
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); ~n9-
TImageManipulation& operator=(const TImageManipulation & imSource); 1"
#W1im
void __fastcall DoRotate(void); Y%YPR=j~ &
}; |3uE"\nfA
#endif o,DI7sb
Yc~c(1VRz
2.编辑风格: nISfRXU;
H^0`YQJ3
(1)缩进 FW!1 0K?
ARa9Ia{@
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 YhJ*(oWL
hxj[gE'R(
(2)空格 nY=]KU
a3(q;^v
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 H_+!.
6ZwFU5)QE/
(3)对齐 D3kx&AR
etLA F
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 a?ii)GGq
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: w@ \quy:
int Value; t?cO>4*|
int Result; A]mXV4RmI
int Length; jBnvu@K "
DWORD Size; x#&%lJT
DWORD BufSize; 7Jvb6V<R
char * pBuf; PU{7s
void * pOutputBuf; ]QK@zb}x
LPCSTR * pPath; 9lCZi?
1
Ll<^P
(4)空行 {;Ispx0m
`DcZpd.n
程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行,由于BCB会自动产生一行“//------”做分隔,另因每个函数还要有函数说明注释,故通常只需空一行或不空,但对于没有函数说明的情况至少应再空一行。对自己写的函数,建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行。类中四个“p”之间至少空一行,在其中的数据与函数之间也应空行。 bF{14F$
o&vODs
(5)注释 f/K:~#k
`PeWV[?
对注释有以下三点要求: *kWrF* )J
A.必须是有意义。 B:QAG
B.必须正确的描述了程序。 *Wmn!{\g
C.必须是最新的。 YF(TG]?6
注释必不可少,但也不应过多,以下是四种必要的注释: "N4rh<<
A.标题、附加说明。 f3Cjj]RFv
B.函数说明。对几乎每个函数都应有适当的说明,通常加在函数实现之前,在没有函数实现部分的情况下则加在函数原型前,其内容主要是函数的功能、目的、算法等说明,参数说明、返回值说明等,必要时还要有一些如特别的软硬件要求等说明。 UkV{4*E
C.在代码不明晰或不可移植处必须有一定的说明。 )4/227b/(
D.及少量的其它注释。 @Zd/>'
注释有块注释和行注释两种,分别是指:“/**/”和“//”建议对A用块注释,D用行注释,B、C则视情况而定,但应统一,至少在一个单元中B类注释形式应统一。 nolLeRE1
举例如下: ~i)IY1m"
/*************************************************************************** vTF_`X
函数名称:ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) ;*_U)th
功能:该函数主要是完成如下的功能 I%fz^:[#<
设计目的:设计该函数主要是为了解决。。。 y:N>t+'5
设计原理:该函数是这样设计的。。。 "lJ[H=\
实现方法/过程:为了实现函数的目的,这个函数是这样实现的。。。 )./'`Mx?
出入口参数: #{u>
ParamType1 Param1:类型ParamType1,这个参数是。。。 @x
z?^20N
。。。 Z )f\^
返回值描述: .ko}m{
设计修改日志: ,
,=7deR
2001/4/16 第一次设计 8C!D=Vhh
2001/4/17 修改了。。。
-Y"'=zkO
2001/4/18 添加了。。。删除了。。。 D/=
AU
相关函数: auP6\kpMe
其他补充说明: GMO|A.bzzN
**************************************************************************/ (0/)vZc
ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) drZ1D s
{ #`9D,+2iB%
int Value; xX]92Q
int Result; }R -azN;
DWORD Size; EO[UezuU
char * pBuf; yAt,XG3
$5;RQNhXh
。。。。 0Zv<]xO
} ;\5^yDv[e
ssy+x;<x,
(6)代码长度: Lp?JSMe
q:D!@+U
对于每一个函数建议尽可能控制其代码长度为53行左右,超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础,同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码,完全可以将起独立成为一个具备公用性质的函数,放置于一个公用模块中(Common.cpp/Common.h) LVj62&,-
jS,zdJs=
3.符号名的命名(包括变量、函数、标号、模块名等) #r4S%
ihrl!A5
选用有实际意义的英文标识符号或缩写符号,名称中尽可能不使用阿拉伯数字,如这样的名称是不提倡的:Value1,Value2,Value3,Value4…..。 /6%<