使用doxygen文档化代码

1. 生成配置文件:doxygen -g -s [Doxyfile] (-g:生成配置, -s:生成简单配置,去除配置项解析)

  • PROJECT_NAME
  • PROJECT_NUMBER
  • OUTPUT_DIRECTORY
  • OUTPUT_LANGUAGE
  • INPUT
  • RECURSIVE
2. 在代码编写注解
  • 请在要注解内容的前一行进行注解(可以为名字空间,类,方法进行注解)
  • 在成员变量同行结尾,编写注解,为成员变量添加解析
3. 生成文档:doxygen
参考:

发表评论