Python 中 doxygen 风格文档字符串的 Vim 语法高亮显示

我开始与doxygen生成我的 Python 代码的文档。 我用doxypy过滤器来预处理 Python 文档字符串。 我的目标是在 Python 中对 doxygen 注释进行良好的语法突出显示。

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

set syntax=c.doxygen

我在 Python 中尝试了相同的命令，但什么也没得到： 设置语法=python.doxygen

我也做了一些谷歌搜索，但找不到任何有趣的东西

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

class CompilationTab:
    """
    The compilation tab of the verif GUI. It contains the layout description
    and the functions required to deal with specific behaviors of the tab
    """
    def __init__(self, notebook, tab_name):
        """
        The class constructor.

        @param notebook Notebook: The parent @c Notebook widget
        @param tab_name String: The display name of the tab
        """

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

如果你调查syntax/doxygen.vim您可以在文件的前言中读取当前仅

cpp, c, idl, doxygen and php

文件受支持。

Since doxygen.vim与syn region我在命令中搜索定义多行字符串的行syntax/python.vim.

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

syn region pythonString start=+[uU]\=\z('''\|"""\)+ end="\z1" keepend

源自其中的内容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

to ~/.vim/after/syntax/python.vim或手动执行它们。

此外，您可能需要手动自定义添加的 doxygen 突出显示组的颜色。至少我会这样做，因为最终的外观不符合我的品味。

或许是fold的论点syn命令对您特别感兴趣。如果你设置foldmethod to syntax您可以折叠和展开多行注释。如果您无法再忍受这些颜色并且懒得调整它们，这似乎很有用:)

没有 doxygen 突出显示：

与 doxygen 突出显示和g:doxygen_enhanced_color == 1: