How to comment in Vim's config files: ".vimrc"?

Question

How do I add a comment in Vim's configuration files, like .vimrc?

score 591 · Accepted Answer · edited Apr 04 '22 at 12:55

591

A double quote to the left of the text you want to comment.

Example: " this is how a comment looks like in ~/.vimrc

To be clear: Do not include a closing double quote. (See comment from Arslan Ali below.)

edited Apr 04 '22 at 12:55

Wenfang Du

answered Jan 09 '10 at 07:57

Myles

71

And it shouldn't have a closing `"`. – Arslan Ali Mar 21 '15 at 10:12
5

And it shouldn't be an inline comment, for inline (better: at-the-end-of-line comments) you can use `command foo |" my comment` (pipe for command separaion needed) – Hartmut Pfarr Sep 23 '19 at 20:03

score 141 · Answer 2 · edited Mar 01 '15 at 16:48

141

"This is a comment in vimrc. It does not have a closing quote

edited Mar 01 '15 at 16:48

Arslan Ali

answered Jul 15 '14 at 20:41

user3670292

2

add a pipe before the double qoute if there is a command on the left of the comment – Hartmut Pfarr Sep 23 '19 at 20:04

Randy Lam · Answer 3 · 2022-12-06T09:52:26.123

14

Same as above. Use double quote to start the comment and without the closing quote.

Also, you can have command followed by comment in file .vimrc just like below:

set nu  "display line number

edited Dec 06 '22 at 09:52

answered Jul 20 '17 at 02:52

Randy Lam

score 14 · Answer 4 · edited Nov 03 '21 at 10:46

14

You can add comments in Vim's configuration file by either:

" brief description of the command

or:

"" commented command

Taken from here

edited Nov 03 '21 at 10:46

ZaydH

answered Nov 18 '20 at 22:55

Saurabh

4 Answers4