接触Doxygen后，认识到其强大之处，一口气将之前的烂代码重构了一遍，所有的文件头，函数注释等等都是手动添加注释。在keil中可以看到其对JavaDoc风格的注释有高亮，非常好看。但是keil这个IDE作为编译器和调试工具，好用的没话说，作为编辑器却非常不能与时俱进。自动补全，代码缩进都超烂 ...

1.Doxygen简介 Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。 目前Doxygen可处理的程序语言包含C/C++、Java ...

背景 这一块的内容更多的是作为了解，但是可以以这样的规范作为自己的编程注释习惯，提高自己的软实力。 Doxygen注释语法 注释格式 块注释建议统一使用 行注释建议统一使用 Doxygen常用注释命令 Doxygen注释示例 1.项目注释 项目注释块用于对项目进行描述 ...

一、doxygen应用场景： doxygen可以用来管理目前主流的编程语言的注释而形成文档系统。（包括C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran等）。doxygen官网地址（http ...

　　　　调试Bug说明 　　　　　　解决的bug说明，@bug　　　　警告说明 (warning)　　　　　　定义一些关于这个函数必须知道的事情，@warning　　　　备注说明 (rem ...

前言 ​ 程序中注释的规范和统一性的重要性不言而喻，本文就推荐一种在用vscode编写代码时自动化生成标准化注释格式的方法，关于Doxygen规范及其使用可查看博文 代码注释规范之Doxygen。 ​ 本方法仅作为Doxygen注释的辅助作用。 Vs code自动生成Doxygen格式注释 ...

用doxygen风格注释代码生成文档 目录 用doxygen风格注释代码生成文档 1. 说明 2. 具体操作 2.1 生成头部注释 2.2 安装doxygen 2.3 工程配置 ...

Chapter 1 - 准备工作 (Windows环境) 1.1 程序包下载 1. Doxygen 　　* 源码： git clone https://github.com/doxygen/doxygen.git 　　* GUI版本：点击下载 　　* 便携压缩包版本：下载 ...