在vim中格式化注释,以#'开头(散列划线)

时间:2016-10-21 12:20:15

标签: python r vim format comments

使用vim,我使用gw或gwap在python或R中自动格式化长注释,vim在需要的行的开头自动插入#-signs。在python和R中,自动文档生成的注释都以#'而不是#,而vim不知道如何处理这些。

如何用#'教vim这些行?也是评论,当将行格式化为块以将#' -signs添加到每行的开头时?

最小例子:

#' Some random text. Please
#' format me 
#' nicely by
#' typing gwap anywhere in this paragraph.

应该变得像:

#' Some random text. Please format me 
#' nicely by typing gwap anywhere in
#' this paragraph.

1 个答案:

答案 0 :(得分:3)

您需要展开{​​{3}}:

'comments' 'com'        string  (default
                                "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
                        local to buffer
                        {not in Vi}
                        {not available when compiled without the |+comments|
                        feature}
        A comma separated list of strings that can start a comment line.  See
        |format-comments|.  See |option-backslash| about using backslashes to
        insert a space.

格式化使用此选项来识别评论领导者。每个以逗号分隔的条目的格式为{flags}:{string},其中flags控制使用哪种类型的注释格式。

b:#'添加到该列表,使文本格式插入匹配的评论标题,b代表需要空白,因此只有#'后跟一些空格,然后是文本,被视为评论领导者:

:set comments+=b:#'

有关详细信息,请参阅comments option

演示:

:help format-comments

考虑到comment formatting with additional <code>comments</code> setting可以再次覆盖comments选项;您可以在相应的~/.vim/ftplugin/<type>.vim文件中添加与覆盖(使用filetype plugin)相同的设置(如果它尚不存在则创建它)。

因此对于Python缓冲区,如果有~/.vim/ftplugin/python.vim文件,它将在执行通用$VIMRUNTIME/ftplugin/python.vim文件后运行,让您为此文件类型设置其他配置,包括额外的注释配置