Python中doxygen风格docstring的Vim语法高亮显示

Question

我开始使用doxygen来生成Python代码的文档。 我使用doxypy过滤器来预处理Python docstring。 我的目标是在Python中有一个很好的doxygen注释语法高亮显示。在

在一个专用的.dox文件中编写我的mainpage时，我发现可以使用以下命令在vim中突出显示doxygen注释：

set syntax=c.doxygen

我尝试对Python使用相同的命令，但什么也没有： 设置语法=python.doxygen在

我也在谷歌上查了一下，没找到什么有趣的东西

下面是我想强调的一段典型代码：

^{pr2}$

有人已经解决了这个问题吗？ 谢谢你的帮助！在

Answer 1

如果您查看syntax/doxygen.vim，您可以在文件的前导码中读取当前仅

cpp, c, idl, doxygen and php

支持文件。在

由于doxygen.vim与syn region命令一起工作，所以我搜索了在syntax/python.vim中定义多行字符串的行。在

命令中定义此区域的有趣部分是

^{pr2}$

从doxygen.vim中的内容派生而来，您可以添加以下行

"delete the following line if you don't want to have enhanced colors
let g:doxygen_enhanced_color=1
runtime! syntax/doxygen.vim
syn region doxygenComment matchgroup=pythonString start=+[uU]\=\z('''\|"""\)+ end="\z1" contains=doxygenSyncStart,doxygenStart,doxygenTODO keepend fold containedin=pythonString

或者手工执行。在

此外，您可能需要手动自定义添加的doxygen高亮组的颜色。至少我会这么做，因为结果看起来不符合我的口味。在

也许您对syn命令的fold参数有特别的兴趣。如果将foldmethod设置为syntax，则可以折叠并展开多行注释。如果你再也无法忍受这些颜色，并且懒得去调整它们，那么这似乎很有用：）

---

不突出显示doxygen：

使用doxygen高亮显示和g:doxygen_enhanced_color == 1：