Формат комментариев в vim, начинающийся с # '(hash-dash)

Question

Используя vim, я использую gw или gwap для автоматического форматирования длинных комментариев в python или R, а vim вставляет # -знаки автоматически в начале строки, где это необходимо , Как в python, так и в R комментарии для создания автоматической документации начинаются с # 'вместо #, и vim не знает, как их обрабатывать.

Как учить vim, что строки с # 'также являются комментариями и при форматировании строки в блок, чтобы добавить #' - знаки в начало каждой строки?

Минимальный пример:

#' 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. 

Answer 1

Вам нужно расширить comments option:

'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}, где флаги управляют типом форматирования комментариев.

Добавить b:#' в этот список, чтобы форматирование текста соответсвующей вставки комментариев лидеров, b стенды для заготовки требуемой, поэтому только #' следуют некоторые пробелы, то текст, рассматривается как комментарий лидера:

:set comments+=b:#' 

См. :help format-comments для получения дополнительной информации.

Демо:

Примите во внимание, что filetype plugin может переопределить параметр comments снова; вы можете добавить ту же настройку, что и переопределение (с :setlocal command) в соответствующий файл ~/.vim/ftplugin/<type>.vim (создайте его, если он еще не существует).

Так что для буфера Python, если есть файл ~/.vim/ftplugin/python.vim, он будет запущен после того, как будет выполнен файл $VIMRUNTIME/ftplugin/python.vim, позволяющий вам установить дополнительную конфигурацию для этого типа файлов, включая дополнительную конфигурацию комментариев.