软件编码规范 <`?%Cz AO
前言: _T_} k:&X
y#= j{
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 fYW9Zbov-
;#^ o5ht
软件编码要遵循以下原则: nb ?(zDJ8
1.遵循开发流程,在设计的指导下进行代码编写。 }Syd*%BR[
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 0\,!
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 nTD4^'
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 nFWiS~(#sW
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 s5V|.R
6.占用资源少,以低代价完成任务。 "xnULQK
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 8m?cvI
;%k C?Vzi
本规范的描述主要以 Borland C++ Builder 语言为例 w"W;PdH)
u\"/EaQ{
一、 规范:以下对本规范作详细说明。 BO8?{~i
SM1L^M3)
1:源程序的文件管理: $<"I*l@
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 (g&@E(@]?
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h @(0O9L
F
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 ~=I:go
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 s< Fp17
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 ^+0>,-)F
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 FlUO3rc|
举例说明: Y/?z8g'p
/************************************************************* c&Eva
类:class TimageManipulation `5"3Cj"M
设计者:wind (2001/05/09) qJ .XI
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 'ka$@,s :
p/G9P +?
版本: H7k@Br
1.0 2001/05/09 完成基本的图象处理功能设计 KT7R0 v
2001/05/10 修改完成一个小Bug. A~^x*#q{4
*************************************************************/ $sUn'62JlU
class TImageManipulation 2dK:VC4U
{ 6 !N2B[9
private://define variant Z$B%V t
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 "rfBYl`
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 gdg``U;)p
//图像处理过程中的相关参数 mD|Q+~=|e
int iBrightness; //色彩亮度 +zXcTT[V
int iContrast; //色彩对比度 -f1lu*3\
int iRedColorBalance; //红色色彩平衡度
}Oqt=Wm
int iBlueColorBalance; //蓝色色彩平衡度 BR_fOIDc
int iGreenColorBalance; //绿色色彩平衡度 KXpbee
bool bRotate; //字体旋转度数 9M;Y$Z
bool bMonochrome; //是否反白显示 fJ6Q:7
private: 4#:C t* f
void __fastcall BrightnessImage(void);//调整图象亮度 z`NJelcuz\
void __fastcall ContrastImage(void);//调整图象对比度 B@#vS=g
void __fastcall DoManipulationImage(void);//图象处理 k8l7.e*
void __fastcall MonochromeImage(void);//图象反白 6'.)z,ts
void __fastcall DoColor(void); ZE=
Yn~XM
void __fastcall DoFilter(int * flt, int Div); 'Sesh'2
/
void __fastcall RotateImage(void);//调整图象色彩平衡 b|;h$otC
e}P@7e h
public://define property ,method,event,function yk(r R
__fastcall TImageManipulation(); VDZOJM)(
__fastcall ~TImageManipulation(); fL("MDt
|n^rI\p%
void __fastcall DoBrightness(int BrightnessIncrement); 3g5r}Ug
void __fastcall DoContrast(int ContrastIncrement); ruyQ}b:zS
void __fastcall DoMonochrome(void); n,LM"N:
void __fastcall DoChangeColorBalance(int RedBalance, `M(st%@n
int BlueBalance, int GreenBalance); NFC/4
void __fastcall SetSourceImage(Classes::TPersistent* Source); -@Urq>^v T
Graphics::TBitmap * __fastcall GetManipulationImage(void); F S$8F
void __fastcall DoBlur(void); nJ/}b/A{
void __fastcall DoSharp(void); bTZ.y.sI
void __fastcall DoEmboss(void); }Z t#OA
$
void __fastcall LoadImageFromFile(AnsiString FileName); SoHaGQox
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); 2@@evQ
TImageManipulation& operator=(const TImageManipulation & imSource); uu"hu||0_
void __fastcall DoRotate(void); jSRi
};
]!N=Z
}LD
#endif |[>yJXxEL@
8j :=D!S
2.编辑风格: s:(z;cj/
;>;it5 l=
(1)缩进 JfK4|{@
;t,v/(/3
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 Pl-9FLJ
LGVy4D
(2)空格 )[r=(6?n
"dE[X`
}=
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 DsD? &:
TtKKU4 yp
(3)对齐 x8~*+ j
Y> ATL
原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在“,”处或运算符处,换行后最好以运算符打头,并且以下各行均以该语句首行缩进,但该语句仍以首行的缩进为准,即如其下一行为“{”应与首行对齐。 2JcP4!RD
变量定义最好通过添加空格形成对齐,同一类型的变量最好放在一起。如下例所示: N8x.D-=gG
int Value; <"xqt7f
int Result; X#K;(.},h
int Length; ll- KK`Ka
DWORD Size; &%8IBT
DWORD BufSize; H*+7{;$
char * pBuf; t7sEY
void * pOutputBuf; =dQ/^C_hj
LPCSTR * pPath; zA:q/i
|JP'j1 Ka
(4)空行 e$JCak=
c&{= aIe w
程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行,由于BCB会自动产生一行“//------”做分隔,另因每个函数还要有函数说明注释,故通常只需空一行或不空,但对于没有函数说明的情况至少应再空一行。对自己写的函数,建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行。类中四个“p”之间至少空一行,在其中的数据与函数之间也应空行。 v-^tj}jA
9_e_Ne`i`?
(5)注释 ]VE3u_kR
V<;_wO^
对注释有以下三点要求: +dRRMyxe4
A.必须是有意义。 U@{>+G[
B.必须正确的描述了程序。 !c-MC|
C.必须是最新的。 c': 4e)
注释必不可少,但也不应过多,以下是四种必要的注释: 1oQbV`P
A.标题、附加说明。 >l/pwb@
B.函数说明。对几乎每个函数都应有适当的说明,通常加在函数实现之前,在没有函数实现部分的情况下则加在函数原型前,其内容主要是函数的功能、目的、算法等说明,参数说明、返回值说明等,必要时还要有一些如特别的软硬件要求等说明。 :i@
$s/
C.在代码不明晰或不可移植处必须有一定的说明。 g jzWW0C
D.及少量的其它注释。 J&