单片机注释格式自用

 

 

/*****************C文件注释********************
  **@file:   文件名
 -----------------------------------------------
  **@data:   日期
 -----------------------------------------------
  **@virsion:版本
 -----------------------------------------------
  **@brief:  简介
 -----------------------------------------------
  **@dverbatim:详细描述
    
  **@endverbatim:
 -----------------------------------------------
  **@attention:注意
 -----------------------------------------------
 ***********************************************/
/* Includes头文件 ---------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Define 简单宏定义-------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Typedef 别名声明--------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Macro define宏定义------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Constants 常量----------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Variables 变量----------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Function prototypes 函数声明--------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Functions 函数定义------------------------------------------------------*/
/*-------------------------------------------------------------------------*/

/*****************头文件注释*******************
  **@file:文件名
 -----------------------------------------------
  **@date:日期
 -----------------------------------------------
  **@brief:简要
 -----------------------------------------------
  **@attention:注意
 -----------------------------------------------
 ***********************************************/
/* Define to prevent recursive inclusion ----------------------------------*/
#ifndef __
#define __
/*-----------------------------------------------------------------------------*/

/* Includes ---------------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Define -----------------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Typedef ----------------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Exported types ---------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Exported constants -----------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Exported Mcro define----------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

/* Exported Function ------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/

#endif

 /*!函数注释
    *@brief
    *@param[in]
    *@param[out]
    *@note
    *@retval
   */