个人Doxgen代码规范

xiaoxiao2021-07-26  123

/** * @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 

转载请注明原文地址: https://www.6miu.com/read-4823339.html

最新回复(0)