C语言编码注释风格

1. 嵌入式代码注释风格

（1）文件头

/*
***************************************************************************
* Copyright: 2019 by Author Name
* File name: 文件名
* Description: 用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，
*                输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
* Author: 作者
* Version: 版本
* Date: 完成日期
* History: 修改历史记录列表， 每条修改记录应包括修改日期、修改者及修改内容简述。
****************************************************************************
*/

（2）函数

/*
***************************************************************************
* Function: // 函数名称
* Description: // 函数功能、性能等的描述
* Calls: // 被本函数调用的函数清单
* Called By: // 调用本函数的函数清单
* Input: // 输入参数说明，包括每个参数的作// 用、取值说明及参数间关系。
* Output: // 对输出参数的说明。
* Return: // 函数返回值的说明
* Others: // 其它说明
***************************************************************************
*/

2. PC端编码注释风格

（1）文件头

/*
 * Copyright: 2019 by Author Name
 * File name: 文件名
 * Description: 用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，
 *                输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
 * Author: 作者
 * Version: 版本
 * Date: 完成日期
 * History: 修改历史记录列表， 每条修改记录应包括修改日期、修改者及修改内容简述。
 */

（2）函数头注释

/*
 * Function: // 函数名称
 * Description: // 函数功能、性能等的描述
 * Calls: // 被本函数调用的函数清单
 * Called By: // 调用本函数的函数清单
 * Input: // 输入参数说明，包括每个参数的作// 用、取值说明及参数间关系。
 * Output: // 对输出参数的说明。
 * Return: // 函数返回值的说明
 * Others: // 其它说明
 */