如何在linux下使用doxygen为代码生成文档

1.Doxygen介绍

 

Doxygen是一款工具，用来为程序的源代码生成说明文档。我们程序员在编写代码时，会为代码添加上注释，方便自己回顾代码，但是对于他人而言，在源码中根据注释寻找想要的函数或者类别，就如同大海捞针一般，非常困难，所以如果能够将源码的注释直接转换为一份说明手册，将会减少后面阅读代码的人很多负担。

使用doxygen来为代码生成文档，它可以处理的语言类型有:C/C++，Python，Java，C#等，而产生的文档的格式有HTML，XML等。只要按照指定的格式编写注释，doxygen就可以提取出这些注释生成文档。

2.代码注释规范

文件注释规范：

文件注释块是对源代码文件进行注释，文件的开头必须有文件注释，否则该文件不会被识别。

函数注释规范：

以下一些标注可以根据需要使用：

命令	命令说明
@see	该函数可以参考哪些函数