函数头部注释编写规范.txt

Rabbit 32Bit RTOS源代码

编写日期：2011.09.24

1、C\C++函数头部注释编写规范：

/*********************************************************************
*函 数 名：xxxxx
*描    述：
*输入参数：
*输出参数：
*返 回 值：
*注    意：
**********************************************************************/


/*********************************************************************
*Function   : xxxxx
*Description: 
*Input      : 
*Output     : 
*Return     : 
*Notes      : 
**********************************************************************/


2、汇编函数头部注释编写规范

;*********************************************************************
;*函 数 名：xxxxx
;*描    述：
;*输入参数：
;*输出参数：
;*返 回 值：
;*注    意：
;*********************************************************************


;*********************************************************************
;*Function   : xxxxx
;*Description: 
;*Input      : 
;*Output     : 
;*Return     : 
;*Notes      : 
;*********************************************************************


说明：
    描述：描述函数功能及性能
    输入参数：输入参数的作用，取值及参数间关系说明
    输出参数：函数参数以指针的形式传递，修改指针指向的内容以输出值
    注意：调用本函数须注意的事项