干货|教你使用Doxygen制作出漂亮程序文档

Posted 2021-09-07 果果小师弟

摘要：不知道大家有没有把自己的代码整理成文档的习惯，有没有给自己的代码一个非常漂亮的注释，就像下图这样。

如果你写了一个结构体或者枚举是否也是这样注释的？

如果每个人的注释都是这样写的话，被人怎么可能看不懂你的代码？如果你不是这样的话，你就必须要看这篇文章了。

等等，别走！还有~

你是不是也看过很多说明文档，比如下面这样的关于STM32标准外设驱动文档。你有没有想象过自己的代码也是可以这样打包成这样一个非常漂亮的文档的？

今天就教大家如何给写注释，如何写出漂亮规范的注释，让人看着心旷神怡，透人心脾。如何写出规范的说明文档，让人看了直呼内行，给你点赞！