C语言的编码风格-文件描述(1)

本文介绍了C语言编程中文件描述的编码规范,强调了在源文件头部进行注释的重要性,包括版权说明、版本号、生成日期、作者、模块目的/功能等信息。并通过一个示例详细展示了如何组织这些元数据。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

C语言的编码风格-文件描述:

¹源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/************************************************************
 Copyright (C), 1988-1999, Rx. Co., Ltd.
 FileName: example.cpp
 Author: longronglin
 Version : 1.0
 Date: 2006-10-05
 Description:     
 Function List:  
    1. ------
    2. ------
 History:      
      <author> <time> <version >  <desc>
      David           96/10/12     1.0                modify xxx .
***********************************************************/
说明:Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值