软件编码规范 qtD3<iWV
前言: T'0Ot3m`
-E?h^J&U
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 !~"q$T>@
tq8B)<(]
软件编码要遵循以下原则: ,)@Q,EHN;
1.遵循开发流程,在设计的指导下进行代码编写。 3tMs613
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 Vp.($
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 +FP*RNM
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 YYzj:'
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 Q
*![u5#
6.占用资源少,以低代价完成任务。 h1^q};3!W\
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 ~ou*'
w@
kQxY"HD
本规范的描述主要以 Borland C++ Builder 语言为例 !i&^H,
<iajtq<Z
一、 规范:以下对本规范作详细说明。 DK}k||-
Hc ]/0:
1:源程序的文件管理: K{%}kUj>
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 ]s?BwLU6
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h H-K,Q%;C@
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 ;H9d.D8
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 CLg;
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 >?ZH[A
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 h3$.`
>l
举例说明: {.GC7dx
/*************************************************************
q+>J'UGb
类:class TimageManipulation AkrUb$ }
设计者:wind (2001/05/09) yQ?N*'}$
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 <.s=)}'`P
/%\E2+6
版本: X3NHQMI
1.0 2001/05/09 完成基本的图象处理功能设计 {w$1_GU
2001/05/10 修改完成一个小Bug. 7hqa|
*************************************************************/ %3M(!X:[
class TImageManipulation t,4q]Jt
{ \Lv
eZ_h5
private://define variant lpQsmd#
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 ~+d?d6*c
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 y TfAS.
//图像处理过程中的相关参数 "45O!AjP
int iBrightness; //色彩亮度 &~ QQZ]q6
int iContrast; //色彩对比度 sPYG?P(l
int iRedColorBalance; //红色色彩平衡度 R?a)2jl
int iBlueColorBalance; //蓝色色彩平衡度 7afD^H%
int iGreenColorBalance; //绿色色彩平衡度 |kyxa2F{
bool bRotate; //字体旋转度数 wrv-"%u)
bool bMonochrome; //是否反白显示 ?vuM'UH-
private: WX&Man!f
void __fastcall BrightnessImage(void);//调整图象亮度 WHk/Rg%<
void __fastcall ContrastImage(void);//调整图象对比度 axW3#3#`
void __fastcall DoManipulationImage(void);//图象处理 -yHVydu=
void __fastcall MonochromeImage(void);//图象反白 RUC
V!L
void __fastcall DoColor(void); *lRP ZN
void __fastcall DoFilter(int * flt, int Div); /Y_F"GQ
void __fastcall RotateImage(void);//调整图象色彩平衡 L']EYK5
-g(&5._,ZW
public://define property ,method,event,function uh*b[`e
__fastcall TImageManipulation(); E}sjl
__fastcall ~TImageManipulation(); <"Z]S^>$
L!x7]g,^
void __fastcall DoBrightness(int BrightnessIncrement); T%A45BE
V
void __fastcall DoContrast(int ContrastIncrement); :[z=u
void __fastcall DoMonochrome(void); KY9sa/xO
void __fastcall DoChangeColorBalance(int RedBalance, fo9O+e s
int BlueBalance, int GreenBalance); F/sXr(7
void __fastcall SetSourceImage(Classes::TPersistent* Source); jFf2( AR
Graphics::TBitmap * __fastcall GetManipulationImage(void); ( >zXapb2
void __fastcall DoBlur(void); /bv`_>
void __fastcall DoSharp(void); -H5n>j0!{
void __fastcall DoEmboss(void); Wu(6FQ`H
void __fastcall LoadImageFromFile(AnsiString FileName); -&I%=0q
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); 6*u#^">,<
TImageManipulation& operator=(const TImageManipulation & imSource); t33/QW
r
void __fastcall DoRotate(void); uF_gfjR[m
}; -e_IDE
#endif _IBIx\F
;|Idg"2
2.编辑风格: /Aooh~
H
RJz
(1)缩进 jE|Ju:}&
D[ U[D
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 - ?_aYJ
3CK4a,]Dm
(2)空格 _doX&*9u
dIgaw;Ch]
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 /_}xTP"9
GzxtC&
(3)对齐 [ R1S+i
-fIX6
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 t"k6wv;Tq
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: Fn.wd`'0
int Value; E,&BP$B
int Result; zim]3%b*A;
int Length; ^Lr)STh
DWORD Size; ~9c?g(0
DWORD BufSize; *@[DG)N
char * pBuf; "W$,dWF
void * pOutputBuf; fx(^}e
LPCSTR * pPath; =$;i
6<jh0=$
(4)空行 4^vEMq8lB
5RCQ<1
程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行,由于BCB会自动产生一行“//------”做分隔,另因每个函数还要有函数说明注释,故通常只需空一行或不空,但对于没有函数说明的情况至少应再空一行。对自己写的函数,建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行。类中四个“p”之间至少空一行,在其中的数据与函数之间也应空行。 c'B6E1}sx
v1%rlP
(5)注释 )X2=x^u*U
u~FXO[b
对注释有以下三点要求: jH#Tt;
A.必须是有意义。 ykcW>h
B.必须正确的描述了程序。 6!7LgM%4
C.必须是最新的。 }w .[ZeP
注释必不可少,但也不应过多,以下是四种必要的注释: Y^$^B,
A.标题、附加说明。 o"dX3jd
B.函数说明。对几乎每个函数都应有适当的说明,通常加在函数实现之前,在没有函数实现部分的情况下则加在函数原型前,其内容主要是函数的功能、目的、算法等说明,参数说明、返回值说明等,必要时还要有一些如特别的软硬件要求等说明。 w=5 D>]
C.在代码不明晰或不可移植处必须有一定的说明。 F`KA^ZI
D.及少量的其它注释。 ,DsqKXSU
注释有块注释和行注释两种,分别是指:“/**/”和“//”建议对A用块注释,D用行注释,B、C则视情况而定,但应统一,至少在一个单元中B类注释形式应统一。 rKEi1b
举例如下: +>mbBu!7
/*************************************************************************** Lsv[@Rl
函数名称:ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) ]Tk3@jw+b
功能:该函数主要是完成如下的功能 #ky]@vyO
设计目的:设计该函数主要是为了解决。。。 GADb Xp3
设计原理:该函数是这样设计的。。。 \o3)\
e]o
实现方法/过程:为了实现函数的目的,这个函数是这样实现的。。。 , tJ%t#
出入口参数: dYV'<
ParamType1 Param1:类型ParamType1,这个参数是。。。 S~fUR n
。。。 !i=LQUi.
返回值描述: 8?#4<4Ql8
设计修改日志: ^*(*tS|M
2001/4/16 第一次设计 A.tONPi
2001/4/17 修改了。。。 lj0"2@z3"E
2001/4/18 添加了。。。删除了。。。 VL=. JwK
相关函数: ;1PnbU b
其他补充说明: _V\rs{
5
**************************************************************************/ #T:#!MKa
ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) 6Yhd [I3
{ )cOw9s
int Value; %&m/e?@%I
int Result; A_3V1<J`]
DWORD Size; m`luMt9
char * pBuf; 8JxJ>I-9p
1FCqkwq[
。。。。 mOji\qia
} 6vp\~J
G?$|aQ0j
(6)代码长度: ?u.&BP
, 6 P:S7
对于每一个函数建议尽可能控制其代码长度为53行左右,超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础,同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码,完全可以将起独立成为一个具备公用性质的函数,放置于一个公用模块中(Common.cpp/Common.h) tUouO0_l
/W&R