注释格式

1、文件注释
/*
 * fmcVoltage.h
 *
 *  Created on: 2018/08/20
 *      Author: zhu.gd
 */

 

 

2、函数注释：
/*
 * @Brief:
 *        Export GPIO
 *
 * @Param:
 *        iGPIO_number        [the number of GPIO, such as 0,1]
 *
 * @Return Value:
 *        0                    [normal]
 *        !0                    [Error]
*/

 

3、分段注释
//======================================================================
// Referenced Header File
//======================================================================

//======================================================================
// Macro Definition
//======================================================================

//======================================================================
// Structure Definition
//======================================================================

//======================================================================
// Variable Declaration
//======================================================================

 
//======================================================================
// Function Declaration
//======================================================================

 

//======================================================================
// Variable Definition
//======================================================================

 

//======================================================================
// Function Definition
//======================================================================