源文件的注释

[复制链接]
877|7
 楼主| peace555 发表于 2015-7-28 21:39 | 显示全部楼层 |阅读模式
源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
 楼主| peace555 发表于 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 是修改历史记录列表,每条修改记录应包括修改日期、修改
者及修改内容简述。
飞翔的控制器 发表于 2015-7-28 21:49 | 显示全部楼层
这个我都没有太怎么写,一般都是我自己看
huihui520 发表于 2015-7-28 21:55 | 显示全部楼层
这个不错,学习了
huihui520 发表于 2015-7-28 22:06 | 显示全部楼层
好,我一般没有这么多,就一个功能,时间,版本
历史暴君 发表于 2015-7-28 22:09 | 显示全部楼层
这个是华为的规范吧
zheng522 发表于 2015-7-28 22:12 | 显示全部楼层
这个好,我收了
heping517 发表于 2015-7-28 22:13 | 显示全部楼层
不错不错
您需要登录后才可以回帖 登录 | 注册

本版积分规则

89

主题

620

帖子

2

粉丝
快速回复 在线客服 返回列表 返回顶部