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是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。