源文件的注释

只看该作者 · 2015-7-28 21:39

源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例：源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。

只看该作者 · 2015-7-28 21:40

/************************************************************
  Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
  FileName: test.cpp
  Author:       Version :       Date:
  Description:    // 模块描述
  Version:       // 版本信息
  Function List: // 主要函数及其功能
1. -------
  History:       // 历史修改记录
   <author>  <time> <version > <desc>
   David 96/10/12    1.0    build this moudle
***********************************************************/
说明：Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与
其它文件关系等。History 是修改历史记录列表，每条修改记录应包括修改日期、修改
者及修改内容简述。