BCB软件编码规范

（5）注释

对注释有以下三点要求：

A.必须是有意义。

B.必须正确的描述了程序。

C.必须是最新的。

注释必不可少，但也不应过多，以下是四种必要的注释：

A.标题、附加说明。

B.函数说明。对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明。

C.在代码不明晰或不可移植处必须有一定的说明。

D.及少量的其它注释。

注释有块注释和行注释两种，分别是指：“/**/”和“//”建议对A用块注释，D用行注释，B、C则视情况而定，但应统一，至少在一个单元中B类注释形式应统一。

举例如下：

/***************************************************************************

函数名称：ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2)

功能：该函数主要是完成如下的功能

设计目的：设计该函数主要是为了解决。。。

设计原理：该函数是这样设计的。。。

实现方法/过程：为了实现函数的目的，这个函数是这样实现的。。。

出入口参数：

ParamType1 Param1：类型ParamType1，这个参数是。。。

。。。

返回值描述：

设计修改日志：

2001/4/16　　第一次设计

2001/4/17　　修改了。。。

2001/4/18　　添加了。。。删除了。。。

相关函数：

其他补充说明：

**************************************************************************/

ResultType MyFunction(ParamType1 Param1, ParamTyp2,Param2)
{
int　　　　Value;
　　 int　　　　Result;
DWORD Size;
char *　　pBuf;

　　 。。。。
}

(6)代码长度：

对于每一个函数建议尽可能控制其代码长度为53行左右，超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础，同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码，完全可以将起独立成为一个具备公用性质的函数，放置于一个公用模块中(Common.cpp/Common.h)

3．符号名的命名（包括变量、函数、标号、模块名等）

选用有实际意义的英文标识符号或缩写符号，名称中尽可能不使用阿拉伯数字，如这样的名称是不提倡的：Value1,Value2,Value3,Value4…..。

例如：

file(文件),code(编号),data(数据),pagepoint(页面指针), faxcode(传真号) ,address(地址),bank(开户银行),……

变量名称:由（前缀+修饰语）构成。

（1）生存期修饰：用l（local）表示局域变量，p(public)表示全局变量，s(send)表示参数变量

（2）类型修饰：用s(AnsiString)表示字符串,c(Char)表示字符,n(number)数值,i(intger)表示整数,d(double)表示双精度,f(float)浮点型,b(bool)布尔型,d(date)表示日期型.

例如：

li_length表示整形的局域变量,是用来标识长度的.ls_code表示字符型的局域变量,用来标识代码.

控件名称：由（前缀+修饰语）构成。前缀即为控件的名称。

按钮变量　Button+Xxxxxxx　　例如：ButtonSave,ButtonExit,ButtonPrint等

题标变量　Label+Xxxxxxxx　　例如：LabelName,LabelSex等

数据表变量 Table+Xxxxxx　　　例如：TableFile,TableCount等

查询变量　Query+Xxxxxx　　　例如：QueryFile,QueryCeneter等

数据源变量 DataSource+Xxx　　　例如：DataSourceFile,DataSourceCenter等

。。。。。。。。。。。。。。。。

(注：对于与表有关的控件“修饰语”部分最好直接用表名。)

4：输入输出

输入和输出

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!