使用Dcxygen对代码进行文档自动生成。软件使用:doxygen-1.8.13、graphviz-2.38、htmlhelp。
其中注释模板如下:
文件注释
/**
* @file pro.c
* @brief
* @details
* @addtogroup Description
* @author AD
* @version 0.01
* @date 2017/3/9
****************************************************************
* Copyright (c), 2017, MiLink Co., Ltd.
****************************************************************
* Edit History \n
* xxx \n
* DATE NAME DESCRIPTION \n
* 2017/03/09 yitakabe.wei Create. \n
****************************************************************/
函数注释
/**
* func function
* @param[in] param interpret
* @return result_interpret, see other_fun()
* @note func description
*/
块注释
/**
* @name Name
* @{
*/
/** Block1 */
/** Block1 */
/** Block3 */
/** @} **/