LINUX下Doxygen的配置与使用

Posted 2020-10-14 大雨海棠

在大型程序中，对自己的程序有个良好的注释会读者阅读以及自己对程序的维护，尤其写个软件包的时候显得尤为重要。别人推荐了Doxygen来对程序进行注释，自己用了下感觉很不错，推荐大家使用。

我用的系统是Ubuntu16.04,这里主要讲下在该系统下Doxygen的安装与配置，在其他Linux系统下都大同小异。

１. Doxygen的安装

sudo apt-get install doxygen
sudo apt-get install graphviz

其中graphviz是doxygen依赖的包，若不安装，使用doxygen的时候会报错。

2. DoxygenToolkit.vim插件配置

1)下载DoxygenToolkit.vim 插件   

　　下载地址 :http://www.vim.org/scripts/script.php?script_id=987 

　　打开该网址后，搜索DoxygenToolkit.vim，然后下载下来。

2) 将下载的文件DoxygenToolkit.vim放到vim的plugin 文件夹中

　　一般linux的vim的plugin文件夹在/usr/share/vim/vim74/plugin下（我用的vim74)。如果不在该文件夹下 ,利用sudo locate /plugin搜索即可得到。

3)修改vimrc文件

　　在vimrc文件最后加入如下命令：　　

    let g:DoxygenToolkit_briefTag_pre="@Synopsis      "   
    let g:DoxygenToolkit_paramTag_pre="@Param         "   
    let g:DoxygenToolkit_returnTag   ="@Returns       "   
    let g:DoxygenToolkit_blockHeader="============================================================================"   
    let g:DoxygenToolkit_blockFooter="============================================================================"        
    let g:DoxygenToolkit_authorName="XIU"   
    let g:DoxygenToolkit_fileTag = "@filename      "  

其中：DoxygenToolkit_authorName="XIU"　根据自己的名字来进行修改。

３．使用Doxygen插件

　　在配置完Doxygen之后，就可以用Doxygen来对自己的程序的进行注释啦，详细的使用方式可见博文:http://blog.csdn.net/omenglishuixiang1234/article/details/51122535。

 

　　

 

原始博文：http://blog.csdn.net/omenglishuixiang1234/article/details/51122535