我们正在考虑将 Doxygen 文档添加到 C++ 头文件中,但有些人不希望默认看到冗长的 Doxygen 文档。
.vimrc 中是否有默认折叠(折叠)Doxygen 注释的方法?
注意:我尝试过autocmd FileType c,cpp set foldmethod=syntax
将折叠所有匹配的语法,但我无法弄清楚如何避免折叠函数、类等,即只折叠 Doxygen 文档格式。
如果 vim 的 C-fold 插件,另一种看起来可能是一个不错的解决方案。这是使其正常工作的详细安装顺序:
- 添加 Doxygen 语法高亮
(a) 从http://vim.sourceforge.net/scripts/script.php?script_id=5安装它,它将创建~/.vim/syntax/doxygen.vim
.
(b)~/.vim\ftdetect\doxygen.vim
用这一行添加:
au BufNewFile,BufRead *.doxygen setfiletype doxygen
(c)~/.vim/syntax/doxygen_load.vim
加上这两行:
au! Syntax {cpp,c,idl}
au Syntax {cpp,c,idl} runtime syntax/doxygen.vim
在末尾添加
~/.vimrc
:let mysyntaxfile='/home/dchinner/.vim/syntax/doxygen_load.vim' autocmd FileType c,cpp set foldmethod=syntax autocmd FileType c,cpp set foldlevel=10
请注意, foldlevel 确定最初将折叠多少。高值将确保大多数是开放的。
- 将 C 折叠添加到(取消)折叠代码或注释
(a) 从http://vim.sourceforge.net/scripts/script.php?script_id=1145安装它,它将安装~/.vim/plugins/cfold.vim
和~/.vim/after/syntax/c.vim
.
(b) 在末尾添加~/.vim/syntax/doxygen.vim
:
syn region doxygenComment start= ... keepend fold
完毕!您现在可以使用这些 C-fold 插件组合键:
z[
打开所有 doxygen 风格的评论z]
关闭所有 doxygen 风格的评论z{
打开所有代码块z}
关闭所有代码块
vim 一个带有 Doxygen 注释的文件,然后点击z]
折叠 Doxygen 注释。