Vim provides syntax files that can provide syntax coloring or folding for certain types of files. This tip discusses how to change some features of the standard syntax files to suit a personal preference. Do not change any of the files distributed with Vim because such updates will be lost when Vim is updated. Instead, use the techniques discussed here.
Documentation
Here are some pointers to the Vim documentation on syntax highlighting.
- I want
*.foo
files to be highlighted like HTML files: :help new-filetype - I want to define a syntax file for
*.bar
files. Read the above and also: :help mysyntaxfile - I want to make a few changes to the existing syntax highlighting: :help mysyntaxfile-add
- I want to change some of the colors from their defaults. Again, read :help mysyntaxfile
Python triple-quoted comments
In Vim 7.3 the file vim73/syntax/python.vim
provides syntax highlighting for Python files. That file (correctly) treats """..."""
as a string and highlights it accordingly. If you prefer, instances of """..."""
or '''...'''
that start on the line following a line ending with a colon can be treated as a comment. To do that, create file python.vim
in your "after" syntax directory as in the following. The next Python file you open should treat triple-quoted doc strings in functions as comments (assuming your vimrc includes commands like filetype indent plugin on
and syntax on
).
Add the following to file ~/.vim/after/syntax/python.vim
(Unix) or $HOME/vimfiles/after/syntax/python.vim
(Windows)—you may need to create the directories and the file.
syn region pythonComment \ start=+\%(:\n\s*\)\@<=\z('''\|"""\)+ end=+\z1+ keepend \ contains=pythonEscape,pythonTodo,@Spell
Comments
This tip is vaguely related:
Changing-distribution-syncolor.vim
Even if you compile vim from scratch it is best to save a default syntax-coloring in a file named e.g. syncolor.vim.local or just syncolor.loc and then copy that file over vim's syncolor.vim thereby destroying the syncolors which you wouldn't use anyway. Of course you could save a copy of the original first or get a new one from the source distribution. A very neutral and helpful colour-scheme which has been used with gratitude by all my users is a scheme where comments are green and keywords are bold blue etc. This seems to give gvim/vim a look and feel which most people appreciate:
https://docs.google.com/file/d/0BxtWx2h12yVPOEUzTUFscWp0VVU/edit?usp=sharing
Most suitable for xterm with wheat or cornsilk (light) background. Hope you'll like it. Regards, Donald Axel (donald.axel on gmail).