标准的函数头注释，更加容易跟兄弟们分享自己的成果。

标准1
/*************************************************
Copyright (C), 2009-2018, CPETW. Co., Ltd.
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块
// 或函数的接口，输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表，每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. ...
*************************************************/

 

 

范例1
/************************************************************
Copyright (C), 2009-2018, CPETW. 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
***********************************************************/

 

 

标准2
/*************************************************
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作
// 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
*************************************************/

 

 

标准3--推荐
/*************************************************
Copyright (C), 2009-2018, CPETW. Co., Ltd.
Author: // 作者 Version: // 版本 Date: // 完成日期
Chip://芯片名称
File name: // 文件名
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作
       // 用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
History: // 修改历史记录列表如下
1.Date:// 修改日期
Author: // 修改者
Modification:// 修改内容简述
2. ...
*************************************************/

 

只要复制粘贴到C文件的函数前面就可以了，与同行的兄弟们分享自己的程序是一个人的境界。程序分享的时候要注意完整性，傻傻的做人，兢兢业业做事，快快乐乐生活，让我们一起来分享。