doxygen自动生成文档,注释容易错位的补充

开发过程中,为了简化api开发文档的编写工作,我们可以使用doxygen的标注来进行文档注释,最后自动化的生成相关文档:
参考:https://developer.aliyun.com/article/935529
参考:https://blog.csdn.net/qq_34597963/article/details/144751954
按照相关说明,安装好doxygen,进行简单的配置后,就很可以立即使用了。

  • 使用过程中有一个变量的注释容易被忽略:
    单行注释:注释在一个新的行,前面标记“/**”后不需要符号"<“
 /**新的时间,注释放到单独行,不需要符号'<' */
int NewTime;

如果注释是放到和变量同一个行,则需要在标记“/**”后增加符号"<“。

int OldTime;/*!<旧的时间,注释放到后面,这里前面的符号'<'必不可少*/ 

如此一来,生成的文件描述才和变量一对一对应。
doxygen自动生成文档,注释容易错位的补充_第1张图片

  • 函数参数描述

dt后面要有一个空格,如果函数没有返回值,不要写@return,不然会有错误提示

/**
* @brief 获取实时日期和时间
* @param[in] dt 指向返回DATETIME类型的变量
*/  
extern void GetRtc(DATETIME *dt);  

最后生成的效果就和预想的一致。
doxygen自动生成文档,注释容易错位的补充_第2张图片

你可能感兴趣的:(兆讯cortex系列芯片开发,java,android,数据库,MH2103,兆讯,新龙微)