个人Doxgen代码规范

/**
* @file         filename
* @brief        This is a brief description.
* @details  This is the detail description.
* @author       Huang Zhudong
* @date     2018-
* @version  v1.0
* @par Copyright (c): 
* @par History:          
*/ 

/**
* This is a brief description.
* This is a detail description.
* @param[in]   inArgName input argument description.
* @param[out]  outArgName output argument description. 
* @retval  OK  succeed
* @retval  ERROR   fault 
* @par 
* @par Created in 2018- 
*/ 

/**
* The brief description.
* The detail description.
*/ 
typedef struct 

 int var1;///<Description of the member variable 
}XXXX;


/** Description of the macro */ 
#define XXXX_XXX_XX     0 

/**  Description of global variable  */ 
int g_xxx = 0;   
static int s_xxx = 0; ///<  Description of static variable 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值