以下是对于程序注解的整理,当然最好对工程的运行进行流程图的绘制,记录整体工程的运行框架,这样在以后的使用中,重新拾起来会方便很多。
一般流程图绘制:
注释格式尽量统一,建议使用“/* …… */”。
-
文件头部进行注释
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*****************************************************************************
Copyright: 1988-1999, Huawei Tech. Co., Ltd.
File name: 文件名
Description: 用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
Author: 作者
Version: 版本
Date: 完成日期
History: 修改历史记录列表, 每条修改记录应包括修改日期、修改者及修改内容简述。
*****************************************************************************/
-
函数头部应进行注释
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含