python - Python 中 doxygen 样式文档字符串的 Vim 语法高亮显示

Question

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

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

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
        """

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

Answer 1

如果你查看 syntax/doxygen.vim你可以在文件的序言中阅读目前只有

cpp, c, idl, doxygen and php

支持文件。

自 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

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

此外，您可能必须手动自定义添加的 doxygen 高亮组的颜色。至少我会这样做，因为最终的外观不符合我的品味。

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

---

没有 doxygen 高亮:

带有 doxygen 高亮和 g:doxygen_enhanced_color == 1 :