软件编码规范 "j.oR}s9?#
前言: 7n\j"0z
(4{@oM#H6
通过建立代码编写规范,形成BCB 开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、一致性,保证程序代码的质量,继承软件开发成果,充分利用资源。提高程序的可继承性,使开发人员之间的工作成果可以共享。 oQ-|\?{;A
hD6ur=G8u
软件编码要遵循以下原则: Jc"$p\ $-
1.遵循开发流程,在设计的指导下进行代码编写。 FB=
2.代码的编写以实现设计的功能和性能为目标,要求正确完成设计要求的功能,达到设计的性能。 ^qId]s
3.程序具有良好的程序结构,提高程序的封装性好,减低程序的耦合程度。 qV, $bw
4.程序可读性强,易于理解;方便调试和测试,可测试性好。 qy42Y/8'
5.易于使用和维护;良好的修改性、扩充性;可重用性强/移植性好。 Zjp5\+hHV
6.占用资源少,以低代价完成任务。 >QZt)<[
7.在不降低程序的可读性的情况下,尽量提高代码的执行效率。 OB*Xb*HN
iRj x];:Vu
本规范的描述主要以 Borland C++ Builder 语言为例 lU50.7<08
f@;>M9)<
一、 规范:以下对本规范作详细说明。 zZ+LisS s&
Qq FfR#
1:源程序的文件管理: !s[j1=y
a)组织:每个程序文件单元通常都应由 .cpp、.dfm和 .h 等文件组成,并将单元的公共声明部分放在 .h 文件中。划分单元主要是以类为依据,原则上每个较大的类都应为一个单独的单元,但在类较小且多个小类关系密切等情况下也可几个类共一个单元(建议仅对已经详细测试的较为通用的类采用)。 6(<~1{
X%
b)命名:原程序文件命名采用有意义的格式。例如:对登陆程序来说三个文件的命名应该是这样,.cpp的是 Login.cpp .dfm的是Login.dfm .h的是Login.h ]=86[A-2N
c)文件结构:每个程序文件由标题、内容和附加说明三部分组成。 UTK.tg
(A)标题:文件最前面的注释说明,其内容主要包括:程序名,作者,版本信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。 ev;5?9\E
(B)内容:为文件源代码部分基本上按预处理语句、类型定义、变量定义、函数原型、函数实现(仅对 .cpp 文件)的顺序。 main 、 winmain ,控件注册等函数应放在内容部分的最后,类的定义按 private 、 protected 、 pubilic 、 __pubished 的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。 "- j@GCme
(C)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的最后。 I3zitI;
举例说明: ,QHx*~9
/************************************************************* lc$@Jjg9
类:class TimageManipulation uZ2v;]\Y6
设计者:wind (2001/05/09) s=y9!rr
用途:用于图象处理,实现图象亮度、对比度、反白、色彩平衡等处理 &h4Z|h[01
l=-dK_I?
版本: Z_OqXo=
1.0 2001/05/09 完成基本的图象处理功能设计 |H+k?C-w
2001/05/10 修改完成一个小Bug. : DX/r
*************************************************************/ qq9tBCk
class TImageManipulation `.sIZku
{ ^K77V$v
private://define variant .J6j"
Graphics::TBitmap * pSourceBitmap;//用于存放未经处理的原始图像 {z[HNSyRs
Graphics::TBitmap * pManipulatedImage;//用处存放经过处理后的图象 ukDH@/
//图像处理过程中的相关参数 1(;33),P8
int iBrightness; //色彩亮度 YI),q.3X~
int iContrast; //色彩对比度 9
<kkzy
int iRedColorBalance; //红色色彩平衡度 %yuIXOJ
int iBlueColorBalance; //蓝色色彩平衡度 4Utx
9^
int iGreenColorBalance; //绿色色彩平衡度 #;*ai\6>vD
bool bRotate; //字体旋转度数 4Tzu"y
bool bMonochrome; //是否反白显示 ry'^1~,
private: &A5[C{x
void __fastcall BrightnessImage(void);//调整图象亮度 =<FZ{4
void __fastcall ContrastImage(void);//调整图象对比度 3d)+44G_)
void __fastcall DoManipulationImage(void);//图象处理 c"sw@<HG
void __fastcall MonochromeImage(void);//图象反白 _OxnHf:|
void __fastcall DoColor(void); .&yWHdQC:
void __fastcall DoFilter(int * flt, int Div); -_4jJxh=OB
void __fastcall RotateImage(void);//调整图象色彩平衡 jf)JPa_
$evuPm8G
public://define property ,method,event,function Y'a(J 7
__fastcall TImageManipulation(); l& ^B
__fastcall ~TImageManipulation(); @n;YF5
1d@^,7MF-
void __fastcall DoBrightness(int BrightnessIncrement); ah6F^Kpl{
void __fastcall DoContrast(int ContrastIncrement); %k;FxUKi
void __fastcall DoMonochrome(void); +!V%Q
void __fastcall DoChangeColorBalance(int RedBalance, DIu72\
int BlueBalance, int GreenBalance); q!oZ; $
void __fastcall SetSourceImage(Classes::TPersistent* Source); 4#7@KhK}
Graphics::TBitmap * __fastcall GetManipulationImage(void); g-V\s&}
void __fastcall DoBlur(void); dBq,O%$oq
void __fastcall DoSharp(void); h9n<ped`A;
void __fastcall DoEmboss(void); e/ % ;
void __fastcall LoadImageFromFile(AnsiString FileName); 1yRd10
void __fastcall SaveManipulatedImageAsFile(AnsiString FileName); l;VGJMPi
TImageManipulation& operator=(const TImageManipulation & imSource); cV!/
void __fastcall DoRotate(void); (_n8$3T75
}; J%[N-
#endif T#^6u)
"KTnX#<0
2.编辑风格: B3+WOf5W
c%3
@J+z
(1)缩进 53&xTcv}x
zUgkY`]:BJ
缩进以4个空格为单位。建议在Tools/Editor Options中设置General页面的Block ident为4,Tab Stop为4,不要选中Use tab character。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个“{”“}”单独占一行。 G-i_s6Wu
a5~C:EU0
(2)空格 n_Hnk4
3{LvKe
变量、类、常量数据和函数在其类型,修饰(如 __fastcall 等)名称之间适当空格并据情况对齐。关键字原则上空一格,如: if ( ... ) 等,运算符的空格规定如下:“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正负号),“&”(取址或引用)、“*”(指使用指针时)等几个运算符两边不加空格(其中单目运算符系指与操作数相连的一边),其它运算符(包括大多数二目运算符和三目运算符“?:”两边均加一空格,“(”、“)”运算符在其内侧空一格,在作函数定义时还可据情况多空或不空格来对齐,但在函数实现时可以不用。“,”运算符只在其后空一格,需对齐时也可不空或多空格,“sizeof”运算符建议也在其后空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 +VW]%6+
?QIQ,?.
(3)对齐 <sFf'W_3{
x2&