之前介绍了 doxygen 可以从代码注释中自动提取数据生成文档,文章地址:https://www.madbull.site/?p=1868。
但是有一个前提,就是需要规范编写注释。如果每次写代码还要考虑注释的格式问题,又产生了一部分精力开销,有没有好用的插件呢?有,凡是你想到的,大拿们早就做了。今天介绍一个 vim 插件,DoxygenTookit.vim
项目地址:https://github.com/vim-scripts/DoxygenToolkit.vim
安装
本次示例需要使用 plug.vim 插件,安装方式参看往期文章:https://www.madbull.site/?p=1882 安装章节的第一个段。如果要手动安装,只需要下载了 DoxygenTookit.vim,直接把文件放在 ~/.vim/autoload/ 目录下也是一样的效果。如果是手动安装,这样章节就结束了,可以直接测试了。
在 ~/.vim/vimrc 增加 DoxygenTookit.vim 的支持。

打开 vim ,在命令行执行: :PlugInstall 就会自动从 github 获取此项目。这样这个插件就安装完成了。
根据官方提示,很多数据都可以自己设置。下方截图这些变量直接在 ~/.vim/vimrc 添加就可以。

测试
随便写一个 .c 文件,先写一些基本的代码。然后在 vim 命令行模式下输入: :Dox 、 :DoxLic 、 :DocAuthor 等指令,会向文件自动添加预设的数据。如下图所示。

发表回复