使用doxygen生成文档

在代码中按规定添加注释就可以利用doxygen可以方便的生成文档。

1.代码注释规范(详细信息查看doxygen手册)

         1)函数注释

            /**

             *@brief

             *@param[in]

             *@param[out]

             *@param[in|out]

             *@return

            **/

           2)文件注释

             /**

             *@file

             *@author

             *@date

             *@version

            **/

            3)类型/枚举/宏等

                /**<  */     或者 /// 

                @see 引用链接

2.生成配置文件

        doxygen -g config_name

3.生成文档

        doxygen filename   

           //执行这个命令之后会生成html文件夹和latex文件夹，在html文件夹下直接用浏览器打开index.htm就可以访问，如果要生成pdf文档，需要提前安装texlive和texlive-latex-extra, 然后再latex文件夹下，执行make命令就可以了