Mercurial > vim
changeset 35330:f3b25db9e802
runtime(comment): clarify the usage of 'commentstring' option value
Commit: https://github.com/vim/vim/commit/98fb81846dd1da03c160bfa30dbf96ba48061d53
Author: Christian Brabandt <cb@256bit.org>
Date: Tue Jun 4 20:44:29 2024 +0200
runtime(comment): clarify the usage of 'commentstring' option value
fixes: https://github.com/vim/vim/issues/14905
Signed-off-by: Christian Brabandt <cb@256bit.org>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 04 Jun 2024 21:00:04 +0200 |
| parents | 2a0286c234b8 |
| children | a73a934e173b |
| files | runtime/pack/dist/opt/comment/doc/comment.txt |
| diffstat | 1 files changed, 15 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/runtime/pack/dist/opt/comment/doc/comment.txt +++ b/runtime/pack/dist/opt/comment/doc/comment.txt @@ -1,4 +1,4 @@ -*comment.txt* For Vim version 9.1. Last change: 2024 Apr 26 +*comment.txt* For Vim version 9.1. Last change: 2024 Jun 04 VIM REFERENCE MANUAL @@ -7,6 +7,8 @@ Commenting and un-commenting text. ============================================================================== +See |comment-install| on how to activate this package. + The comment.vim package, allows to toggle comments for a single line, a range of lines or a selected text object. It defines the following mappings: @@ -21,20 +23,25 @@ gcG to comment/uncomment from current l *v_gc* {Visual}gc to comment/uncomment the highlighted lines. -The plugin uses the buffer-local 'commentstring' option value to add or remove +This plugin uses the buffer-local 'commentstring' option value to add or remove comment markers to the selected lines. Whether it will comment or un-comment depends on the first line of the range of lines to act upon. When it matches a comment marker, the line will be un-commented, if it doesn't, the line will -be commented out. Blank and empty lines are not touched. - -If the mapping does not seem to work, chances are high, that this particular -filetype is either not detected by Vim or the filetype plugin does not set the -'commentstring' option. +be commented out. Blank and empty lines are ignored. + +The comment marker will always be padded with blanks whether or not the +'commentstring' value contains whitespace around "%s". + +If the mapping does not seem to work (or uses wrong comment markers), it might +be because of several reasons: +- the filetype is not detected by Vim, see |new-filetype|, +- filetype plugins are not enabled, see |:filetype-plugin-on| or +- the filetype plugin does not set the (correct) 'commentstring' option. You can simply configure this using the following autocommand (e.g. for legacy Vim script): > - autocmd Filetype vim :setlocal commentstring="\ %s + autocmd Filetype vim :setlocal commentstring="%s This example sets the " as start of a comment for legacy Vim Script. For Vim9 script, you would instead use the "#" char: >