软件编码规范 CC^E_j T
前言: k1
-~
#Q"O4 b:8
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 w
ej[+y-
%A/_5;PZ/
软件编码要遵循以下原则: 1|r,dE2k9
1.遵循开发流程,在设计的指导下进行代码编写。 sTRJ:fR
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 O) atNE
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 ;]sYf
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 ``U^COD
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 mLk(y*
6.占用资源少,以低代价完成任务。 >rsqH+oL
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 !g!5_|
qJ4T]FVN
本规范的描述主要以 Borland C++ Builder 语言为例 `D$Jv N
9W ^xlid6
一、 规范:以下对本规范作详细说明。 ~|ss*`CT
"=/ f$Xf
1:源程序的文件管理: _aWl]I){5
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 ;)AfB#:d
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h 6uPcXd:8ZR
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 5ExDB6Bx@y
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 PxFWJ?=
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。
D L'iS
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 8flOq"uK^
举例说明: [U@;\V$
/************************************************************* _ *f
类:class TimageManipulation ``VW;l{
设计者:wind (2001/05/09) k^"bLf(4
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 \!]hU%Un
kX`[Y@nUN
版本: j=?'4sF
1.0 2001/05/09 完成基本的图象处理功能设计 SMH<'F7i
2001/05/10 修改完成一个小Bug. `Z"Q^
*************************************************************/ ~@ jY[_
class TImageManipulation \b=Pj!^gwb
{ $Xm6N@
private://define variant I
pzJ#
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 (6l+lru[
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 Sq\(pfvo
//图像处理过程中的相关参数 ^~`?>}MJ
int iBrightness; //色彩亮度 ^O(=Vry
int iContrast; //色彩对比度 {--0z3n>
int iRedColorBalance; //红色色彩平衡度 U6E\AvbRn
int iBlueColorBalance; //蓝色色彩平衡度 0|&\'{
int iGreenColorBalance; //绿色色彩平衡度 8lF\v /vN
bool bRotate; //字体旋转度数 1NQbl+w#I
bool bMonochrome; //是否反白显示 'y]\-T
private: FTc.]laO
void __fastcall BrightnessImage(void);//调整图象亮度 mrIh0B:`
void __fastcall ContrastImage(void);//调整图象对比度 7\]E~/g
void __fastcall DoManipulationImage(void);//图象处理 7/7Z`
void __fastcall MonochromeImage(void);//图象反白 sg'pO*_&
void __fastcall DoColor(void); /S5|wNu
void __fastcall DoFilter(int * flt, int Div); <@wj7\pQ
void __fastcall RotateImage(void);//调整图象色彩平衡 9,j-Vp!G
8to8!(
public://define property ,method,event,function
X\$ 0
__fastcall TImageManipulation(); goat<\a
__fastcall ~TImageManipulation(); m7EcnQf
E%oY7.~-
void __fastcall DoBrightness(int BrightnessIncrement); 6 DG@?O
void __fastcall DoContrast(int ContrastIncrement); p'7*6bj1
void __fastcall DoMonochrome(void); e:H26 SW
void __fastcall DoChangeColorBalance(int RedBalance, tCxF~L@
int BlueBalance, int GreenBalance); Z6\+
void __fastcall SetSourceImage(Classes::TPersistent* Source); Twn4lG4~
Graphics::TBitmap * __fastcall GetManipulationImage(void); 8UC xnf#
void __fastcall DoBlur(void); QrO\jAZ{Ag
void __fastcall DoSharp(void); cdqB,]"
void __fastcall DoEmboss(void); X\EVTd)@
void __fastcall LoadImageFromFile(AnsiString FileName); 2(5ebe[
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); qTZFPfyU
TImageManipulation& operator=(const TImageManipulation & imSource); n
-(
void __fastcall DoRotate(void); su*Pk|6%
}; m]i @ +C
#endif kmzH'wktt
6T 8!xyi-+
2.编辑风格: DCqY|4Qc
.ERO|$fv
(1)缩进 Ookh<ES>
f&v9Q97=
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 "ju6XdZo
;7N{^"r
(2)空格 AJ#Nenmj
R.=}@oPb
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 CLvX!O(~
l
Va &"
(3)对齐 r.7$&BCng
)95f*wte
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 `+6R0Ch
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: W9NX=gE4
int Value; *CHI2MB
int Result; dy_:-2S
int Length; =zQN[
DWORD Size; ;WR,eI..
DWORD BufSize; q,
O$ %-70
char * pBuf; .r*2|
void * pOutputBuf; ;a:[8 Yi
LPCSTR * pPath; LL:_L<
%*BlWk!Q
(4)空行 4apL4E"r
II6CHjW`;
程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行,由于BCB会自动产生一行“//------”做分隔,另因每个函数还要有函数说明注释,故通常只需空一行或不空,但对于没有函数说明的情况至少应再空一行。对自己写的函数,建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行。类中四个“p”之间至少空一行,在其中的数据与函数之间也应空行。 x _c[B4Tw
(5]}5W*
(5)注释 p]3?gK-
I? ,>DHUX
对注释有以下三点要求: D3|I:Xm
A.必须是有意义。 $D G?M6
B.必须正确的描述了程序。 ~69&6C1Ch
C.必须是最新的。 w@,zFV
注释必不可少,但也不应过多,以下是四种必要的注释: P.gb1$7<
A.标题、附加说明。 '7O3/GDK
B.函数说明。对几乎每个函数都应有适当的说明,通常加在函数实现之前,在没有函数实现部分的情况下则加在函数原型前,其内容主要是函数的功能、目的、算法等说明,参数说明、返回值说明等,必要时还要有一些如特别的软硬件要求等说明。 Gea\,{E9xA
C.在代码不明晰或不可移植处必须有一定的说明。 13taFVdU
D.及少量的其它注释。 $Xq!L
注释有块注释和行注释两种,分别是指:“/**/”和“//”建议对A用块注释,D用行注释,B、C则视情况而定,但应统一,至少在一个单元中B类注释形式应统一。 1GzAG;UUo6
举例如下: ,v"YqD+GC5
/*************************************************************************** 0_ 88V
函数名称:ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) (o`{uj{!
功能:该函数主要是完成如下的功能 A~-b!Grf
设计目的:设计该函数主要是为了解决。。。 2}8v(%s p
设计原理:该函数是这样设计的。。。 GSH>7!.#
实现方法/过程:为了实现函数的目的,这个函数是这样实现的。。。 SL5Ai/X0N
出入口参数: !qG7V:6
ParamType1 Param1:类型ParamType1,这个参数是。。。 j]`PSl+w
。。。 1I:+MBGin
返回值描述: O%bEB g
设计修改日志: gEjdN.
2001/4/16 第一次设计 .9wk@C(Eh_
2001/4/17 修改了。。。 =?!wXOg_
2001/4/18 添加了。。。删除了。。。 ;+ "+3
相关函数: \ Yx/(e
其他补充说明: %7|9sQ:
**************************************************************************/ `nu''B
H
ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2) FJMrs[
{ \-g)T}g,I
int Value; .mR8q+I6
int Result; <7~'; K
DWORD Size; dkz=CY3p%X
char * pBuf; q.;u?,|E/
s7F.sg
。。。。 %^jMj2
} LGn:c;
}4,L%$@n
(6)代码长度: 'dn]rV0(C
!z>6Uf!{
对于每一个函数建议尽可能控制其代码长度为53行左右,超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础,同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码,完全可以将起独立成为一个具备公用性质的函数,放置于一个公用模块中(Common.cpp/Common.h) 2'w?\{}D
\.-bZ$
3.符号名的命名(包括变量、函数、标号、模块名等) ?32&]iM
oW
w(L4A0K[
选用有实际意义的英文标识符号或缩写符号,名称中尽可能不使用阿拉伯数字,如这样的名称是不提倡的:Value1,Value2,Value3,Value4…..。 E 7{U|\
例如: H*}y^)x
file(文件),code(编号),data(数据),pagepoint(页面指针), faxcode(传真号) ,address(地址),bank(开户银行),…… ~A\GT$
变量名称:由(前缀+修饰语)构成。 > ;*b|Ik
(1)生存期修饰:用l(local)表示局域变量,p(public)表示全局变量,s(send)表示参数变量 y+NN< EY@
(2)类型修饰:用s(AnsiString)表示字符串,c(Char)表示字符,n(number)数值,i(intger)表示整数,d(double)表示双精度,f(float)浮点型,b(bool)布尔型,d(date)表示日期型. `x*Pof!Io
例如: [TmIVQ!B
li_length表示整形的局域变量,是用来标识长度的.ls_code表示字符型的局域变量,用来标识代码. c24dSNJg,
控件名称:由(前缀+修饰语)构成。前缀即为控件的名称。 ln6d<;
M5
g%=z_
按钮变量 Button+Xxxxxxx 例如:ButtonSave,ButtonExit,ButtonPrint等 iUN Ib
题标变量 Label+Xxxxxxxx 例如:LabelName,LabelSex等 DW[N|-L
数据表变量 Table+Xxxxxx 例如:TableFile,TableCount等 Vh4X%b$TV
查询变量 Query+Xxxxxx 例如:QueryFile,QueryCeneter等 BI%$c~wS
数据源变量 DataSource+Xxx 例如:DataSourceFile,DataSourceCenter等 <