变量注释规范.txt

Rabbit 32Bit RTOS源代码

编写日期：2011.10.12

基本类型变量注释规范：

/*********************************************************************
*
* multi line long comment
*
**********************************************************************/
type var_name;

or

/* single line long comment */
type var_name;

or

type var_name;    /* short comment */


结构体注释规范：


/*********************************************************************
*结构体名：struct struct_name  (typedef name)
*描    述：
**********************************************************************/
typedef struct struct_name
{
    /* long comment */
    type member_name;   /* short comment */
    /* long comment */
    type member_name;   /* short comment */

}typedef_name;



/*********************************************************************
*Struct Name: struct struct_name  (typedef name)
*Description:
**********************************************************************/
typedef struct struct_name
{
    /* long comment */
    type member_name;   /* short comment */
    /* long comment */
    type member_name;   /* short comment */

}typedef_name;