注释

原则上注释要求使用中文;

文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复
杂的算法需要加上流程说明;

函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数
需要加上变量用途说明;

程序中注释包括:修改时间和作者、方便理解的注释等;





引用一: 文件开头的注释模板

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

** 文件名:

** Copyright (c) 1998-1999 *********公司技术开发部

** 创建人:

** 日 期:

** 修改人:

** 日 期:

** 描 述:

**

** 版 本:

**--------------------------------------------------------------------------
---





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



引用二: 函数开头的注释模板

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

** 函数名:

** 输 入: a,b,c

** a---

** b---

** c---

** 输 出: x---

** x 为 1, 表示...

** x 为 0, 表示...

** 功能描述:

** 全局变量:

** 调用模块:

** 作 者:

** 日 期:

** 修 改:

** 日 期:

** 版本

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

引用三: 程序中的注释模板

/*----------------------------------------------------------*/

/* 注释内容 */

/*----------------------------------------------------------*/

8 程序

a. 程序编码力求简洁，结构清晰，避免太多的分支结构及太过于技巧性的程序，
尽量不采用递归模式。

b. 编写程序时，亦必须想好测试的方法，换句话说，”单元测试” 的测试方案应
在程序编写时一并拟好。

c. 注释一定要与程序一致。

d. 版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要
在文件及函数的修改记录中加以记录。

e. 程序中每个block 的开头 ”{" 及 "}” 必须对齐，嵌套的block 每进一套，
缩进一个tab，TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。

f. 对于比较大的函数，每个block 和特殊的函数调用，都必须注明其功能，举例如下

：

count.divisor = 1193280 / freq; // compute the proper count

OutByte((unsigned short)67, (unsigned char)182); // tell 8253 that a
count is coming

OutByte((unsigned short)66, count. c[0]); // send low-order byte

OutByte((unsigned short)66, count. c[1]); // send high-order byte



×××××××××××××××××××××××××××××××××××××××

bcb，delphi中的变量命名：

遵循匈牙利命名法，命
名必须有意义，制定如下规定

窗体： 以大写的W开始，如About版权窗体， 命名为WAbout

文件：以大写的F开始，如About版权窗体，文件命名为FAbout.cpp

按钮(Button)：如退出按钮，命名为btnExit

……

基类： 加base标记，如报表基类,窗体命名为：WBaseRep, 文件命名为FBaseRep.cpp