I've installed commentary, read the help file, set a commentstring and I can use range:Commentary e.g. :7,14Commentary . So I think everything is set up, but typing gc or gcc on a line does nothing.

Is there some special key sequence I have to use before 'gcc'

Incidentally, in the help file it says "Relies on 'commentstring' to be correctly set", but it doesn't say what 'correctly set' means. So I had to guess a few times and followed the example on the github page for apache. A example of what 'correctly set' means would be useful.

It would be great when commentary could recognize multiple ways of how a comments can be done in a language. This should only work to comment lines out; commenting should use a single commentstring.

As an example see the following comment in C before calling commentary:

// no comment

After using gcc on that line:

no comment

After using gcc a second time:

/* no comment */

At the moment, using gcc on the first comment ends in:

/* // no comment */

I tried ^#\ *%s, but I guess it's not a regex. I'm in Python, and having # characters at a mix of indentation levels is a little confusing. I've been using a pair of mapped regexes to do this for awhile, but I like commentary's toggle abilities and operator-pending mode.

Toggling a line comment (e.g., gcc) does not uncomment a line if that line is missing a space between the comment character and the content. Here's an example:

//console.log

Turns into:

// //console.log

It would be nice if Commentary recognized the comment symbols with or without a for padding. This isn't a big deal if you're the only one working in a file as Commentary always adds the padding, but it becomes problematic when you're trying to manipulate someone else's differently formatted comments.

Is it possible to configure commentary to use // or /**/ inside <script> tags in html files and <!-- --> elsewhere? If so, it'd be nice to have this kind of thing in jsp/php/erb files as well.

is there any way to comment inline like this, in C code for example?

code ; /* comment */

A few times I've caught myself absent-mindedly doing digc to delete the commented block I'm in. This makes as little sense as digq or dig?, but it did make me wish for a text object in commentary that allowed me to refer to the commented-out section I'm in. I realize it wouldn't be symmetrical; there can't be a text object for pre-commented or post-uncommented code, but I think it would be nice to do other things to code that is commented, beyond simply uncommenting it. Thoughts?

I would also like [gc and ]gc for hopping between commented blocks, but I don't want to get too pushy in a single issue.

plugin have it. is it possible to let vim-commentary to support it ? I don't like to add another map except 'gc'

Any idea why \ap wouldn't work for me? At getting to "a", finding myself in the Insert mode. My .vimrc for reference: https://github.com/skozlov/dotfiles/blob/master/vimrc

Thanks!

I have commentstring overriden for vim-commentary

autocmd FileType php setlocal commentstring=//\ %s

but for foldtext I must locally set it back to the original value:

set foldtext=MyFoldText()
function! MyFoldText()
  let l:commentstr = &commentstring
  if &filetype == 'php'
      let l:commentstr="/\\*%s\\*/"
  endif
  echo l:commentstr
  let l:line = getline(v:foldstart)
  let l:regex = substitute(commentstr, '%s', '\\(.*\\)', '')
  let l:line = substitute(l:line, l:regex, '\1', '')
  let l:regex = substitute(&foldmarker,",","\\\\|",'')
  let l:sub = substitute(l:line, l:regex, '', 'g')
  return v:folddashes . l:sub
endfunction

What do you think about adding plugin-specific commentstring variable (&commentstring by default, if not manually set)?

Hi,

while using commentary to comment on javascript files, I have noticed that we add spaces instead of tabs after the commentstring, which breaks linters (jshint) for javascript.

It seems that the plugin gets confused with % comments (like e.g. LaTeX uses). Or maybe I am just confused. Anyway, if I :set commentstring=%%%s, then it comments properly. However, in order to uncomment I have to press \\\ twice: the first time it adds another % before the comment, the second time it removes two %, thereby uncommenting the line.

Am I perhaps setting commentstring wrong or is this a legitimate issue? I've tried \ escaping the % but this just results in an error message and the line getting cleared (I even tried escaping the \).

Steps to reproduce:

vim test.sh

i
#
# This is a test
#
# ohai
#<ESC>gcap

The following works as intended:

i
# This is a test
# ohai<ESC>gcap

The README says one can map other keys to the \ maps, but I would prefer to replace the \ maps altogether.

(I use \ as my leader and already have \\ mapped to something I use all the time (\be -- bufexplorer). Currently vim-commentary clobbers this.)

My workaround is simply to change the maps in commentary.vim, which is fine with me, but I was wondering whether this could be configured.

Anyway, thanks for another top plugin. I even have a chance of following the code because it's fewer than 3,000 lines ;)

For some reason vim-commentary wraps my HTML tags with /* ... */ instead of <!-- ... -->. I'm going with the default configurations, no changes. What am I doing wrong?

Go has two types of comments:

// Single line
/* Multiple
Line */

However, vim-commentary only makes use of the multiple line comment, and uses it as though it were a single line comment.

/* Just */
/* like */
/* this. */

The mappings are creating delays in my maps with shared prefixes, and I'm not sure of a good way to remove them. Perhaps an option that we could set to disable those mappings would be a good compromise.

i remember using a different commenting plugin which normally would insert // and had a 'multiline' operator that would insert /* and */ instead. can haz something like that? or do i just need to tweak something in my .vimrc?

@tpope
Could commentary support block comment in visual mode?
additional information could be provided with buffer vars such as, b:block_cms, b:block_enabled

This is extremely useful when dealing with file types like css (the line based comment of css is way too disturbing for a block).
For example:

Regards

vim-commentary currently comments as:

-# .group-detail.gf-container

while Jade comments look like the following:

// .group-detail.gf-container

hello,everyone! i meet a question about this plugin.

I use the pathogen to manage my plugin, and put the all plugins in the bundle dir. After installing the YouCompleteMe plugin, run the gcc in any type of file, will be annotated into /**/

like this picture:

# first block
# still junk of first code block

# second code block
# here we are
#  further code in second code block

I'd like to uncomment with gcu only the second code block not the first one as well. What do you think about it?

I would like to comment all lines in a fold when it is closed. I have tried the gcc and Visual}gc
combinations but it does not work in neovim nor vim. Is there any way to comment a closed fold?

When I use gcc in a visual selection I get something like the following:

// var example = "hi";
// var anotherExample = "hello";

Could this be changed or given as a setting so that I could have this instead?:

//var example = "hi";
//var anotherExample = "hello";

This change would mainly be because of how I like to differentiate between a // useful comment and a commented out block of code.

On the other hand, if it could support block level comments, that would be better. ;)

Hi!

Would it be possible to escape existing comments in html/xml differently than it is implemented now?
The problem is that the generated xml code is invalid if comments already exist in the file, because -- characters in a commented part are invalid.

Example:
<!-- something -->
becomes
<!-- <1-- something --1> -->

It would be nice if the following happened:
Example:
<!-- something -->
becomes
<!-- <1__ something __1> -->

This renders the page invalid and invalidity completely denies rendering of the file.

In most cases toggling comments is what I want. In some cases I want to force uncommented lines to be commented and leave commented lines commented. I imagine something like this

:g/log.debug/CommentaryComment

would change

log.debug('context', JSON.stringify(context))
...
// log.debug('socket.rooms', JSON.stringify(socket.rooms)) 

to this, effectively commenting out all log.debug statements.

// log.debug('context', JSON.stringify(context))
...
//// log.debug('socket.rooms', JSON.stringify(socket.rooms)) 

https://github.com/tpope/vim-commentary/blob/master/plugin/commentary.vim#L84

Currently you need to use the gc shortcut (or \ for legacy devs like me). Would you ever be willing to make this an optional "setting" so users could modify it in their vimrc? I find when I'm remote pairing w/ java or c# developers they commonly like a "jetbrains" set of shortcuts to stay productive. If I could optionally update this binding (or supply another alongside what I have with gc) it would go a long way.

Thanks for such a great plugin and all your awesome vim community work! This project (and vim itself) has helped make me personally more productive year after year :)

This isn't an issue with commentary per se, but I'm wondering how to assign the commentstring variable for files without explicit FileTypes. For example, I edit R files in Vim and would love to use commentary with them, but adapting

autocmd FileType apache set commentstring=#\ %s

to what seems appropriate

autocmd FileType r set commentstring=#\ %s

has no effect because R doesn't have a Vim filetype. R does have a syntax file ("r.vim"), but the seemingly reasonable

autocmd Syntax r set commentstring=#\ %s

doesn't work. Any help would be most welcome!

I find useful to include a suffix (like "XXX") on part of the comments.
This can be helpful when commenting some lines for a quick test, or as a short time
TODO reminder. As an example:

for (int i = 0; i < count; i++)
{
   // XXX tempDisabled(); -> result of 'gxx'
   // if () -> result of 'gcc '
   {
      dfa
   }
}

I've tried to use commentary to do both regular and suffixed comments.
My first attempt was to change 'commentstring', execute the original commands and then restore using 'commentstring'. The original <Plug> mappings were used in order to avoid copy code from the plugin, preventing that mappings stop working due to plugin updates.

let g:commentary_suffix = ' XXX'
func! CommentarySetSuffix()
   exe "setl commentstring=" . escape(substitute(&commentstring, '\ze%s', 
            \ g:commentary_suffix, ''), ' ')
endfunc
func! CommentaryRemoveSuffix()
   exe "setl commentstring=" . escape(substitute(&commentstring, 
            \ g:commentary_suffix . '\ze%s', '', ''), ' ')
endfunc

Although this approach works for CommentaryLine and CommentaryUndo,

nmap gxx :call CommentarySetSuffix()<CR><Plug>CommentaryLine
         \:call CommentaryRemoveSuffix()<CR>
nmap gxu :call CommentarySetSuffix()<CR><Plug>CommentaryUndo
         \:call CommentaryRemoveSuffix()<CR>

, this can't be applied to Commentary, as it is not possible call CommentaryRemoveSuffix after the motion is entered.

In order to be able to execute a command after the motion it would be necessary to change the plugin code, adding the following at the end of s:go() function:

  if exists("g:Commentary_callback")
    call g:Commentary_callback()
  endif

On the .vimrc:

let g:commentary_suffix = ' XXX'
func! CommentarySetSuffix()
   exe "setl commentstring=" . escape(substitute(&commentstring, '\ze%s', 
            \ g:commentary_suffix, ''), ' ')
   let g:Commentary_callback = function("CommentaryRemoveSuffix")
endfunc
func! CommentaryRemoveSuffix()
   exe "setl commentstring=" . escape(substitute(&commentstring, 
            \ g:commentary_suffix . '\ze%s', '', ''), ' ')
   unlet g:Commentary_callback
endfunc

xmap gx  :<C-U>call CommentarySetSuffix()<CR><Plug>Commentary
nmap gx  :call CommentarySetSuffix()<CR><Plug>Commentary
nmap gxx :call CommentarySetSuffix()<CR><Plug>CommentaryLine
nmap gxu :call CommentarySetSuffix()<CR><Plug>CommentaryUndo

This change makes all but the xmap gx work.

I still didn't figured out why the xmap doesn't worked, but I'm not sure if this is the best approach. Do you have any ideas?

I am facing a very weird issue. For some reason :echo &commentstring prints different values in vim & gvim.

I tried :verbose set commentstring from both vim & gvim, interestingly I got different results. Following is the result of executing this for commentary.vim plugin file :

vim output:

commentstring=/*%s*/

gvim output:

commentstring="%s
    Last set from /user/share/vim/vim73/ftplugin/vim.vim

Immidately I fired up :Scriptnames from your plugin scriptease to list all loaded scripts, but to my surprise the above vim ftplugin is loaded in both vim & gvim.

I am guessing I am missing something ? I am sure you would know.

I tested the plugin by commenting three lines of Lua code:
Two empty lines were added between the three commented lines: that's not what I expected...

This has worked for me for a while, today I noticed a bug

starting with this:

some: css;

}


commenting changes it to this:

/* some: css; */

}


uncommenting changes it to this:

* some: css; *

}

When I noticed it, I updated my plugins, but it didn't help.

When editing either ~/.Xdefaults or ~/.Xresources, the filetype is set to xdefaults according to the output of :set ft?. By default, commentary uses CSS style comments, i.e. /* */. So I consulted the readme and added the following line to my .vimrc:

autocmd FileType xdefaults set commentstring=!\ %s

However, after re-sourcing my config and even restarting vim, I'm still getting the CSS-style comments. I was hoping you might be able to shed some light on this. Thanks in advance.

Hi,

it's nice that you have implemented text-objects for comments.
However, the distinction between inner/all comment only for 'c' seems unnatural to me.
I think it would be better to have something like 'ac'/'ic' text-objects and let people choose whether they want only the text part or the whole comment.

I am annoyed that C/C++ files are always commented with /* .. */, while I hope there could be one line comment. Also some comments are not right set by default, for instance, I cannot get the right comment in elisp files(filetype:lisp). So is it possible to customize?

The mappings \\ and \\\ override selected text when using :behave mswin option.

The vim-commentary documentation states three keyboard mapping examples to comment out whole lines of code, but I'm curious there is any plan to extending this plugin to support portions of a line.

Such as, for example, "\iw" would comment out only single word, and "{Visual}" comment out only highlighted words.

I can attempt to tackle this feature myself, but I'm no Tim Pope when it comes to Vim plugins :)

Is it possible to NOT move the cursor when commenting/uncommenting a line.

Right now, when I use gcc, the cursor moved to the beginning of the line.

Hi,

I noticed that the plugin doesn't play well with a style of comments I have to work with. This C code:

/*-----------
|  comment
|-----------*/
foo();

is commented as:

/* /*----------- */
/* |  comment */
/* |-----------*/ */
/* foo(); */

which, as you can see, causes a syntax error at the end of the comment block. The problem occurs if there is any character other than a space after the left delimiter or before the right delimiter.

I was able to make it work without a syntax error (Vim highlights it as a syntax error but it compiles) by removing the spaces from the delimiters that are added in in s:surroundings() and changing the strlen check from 2 to 1. The result is functional but ugly due to lack of whitespace and Vim's syntax error:

/*/1*-----------*/
/*|  comment*/
/*|-----------*1/*/
/*foo();*/

My suggestion is that the pre-existing '/*' and '*/' should be replaced with ' /1* ' and ' *1/ ' i.e. add spaces around the modified delimiter, but I haven't figured out a way to implement it yet.

In a HTML file, while commenting a code with gcc inside a <script></script> tag, it uses <!----> to mark comments instead of the JS style comment marker //.

Although html style <!-- --> works for .hamlet in the Shakespeare templating language hamlet, the ideal syntax is to simply prepend $# to a line. It would be great if vim-commentary would support that for .hamlet files.

When commenting more than one line, it should comment using a block style comment if available. For example in Java:

// public void static main(String[] args) {
//     System.out.println("Hello, world!");
// }

versus

/* public void static main(String[] args) {
    System.out.println("Hello, world!");
} */

Hi, this just came up at reddit.com
In summary, commentary doesn't toggle comments, that don't have a space in between. E.g. this:

<!--This is a comment-->

won't be properly toggled in a html file.

This could happen because of an application injecting comments or some other user adding comments (who is not using Vim).
I made a patch here

Comments in R should start with '#', but this plugin renders like in C, i.e. /.../

Considering the following block:

# Comment
# Comment 2
# Comment 3
# Comment 4

Highlighting the selection and running gc causes the block to be deleted instead of uncommenting the section.

Edit: Somehow after restarting the terminal window unable to reproduce, closing for now

I use foldmethod=marker foldlevel=0 in my .vimrc and sometimes I want to activate/deactivate some vim plugins, so I use gcc to toggle the comment.

Unfortunately it folds my nested manual folds up completely and this is quite unexpected and annoying behaviour in my opinion. I tested it with just vim-commentary enabled so it seems not to be some side effect of other plugins.

When trying to uncomment a line:
#line
the plugin doesn't recognize it as already commented and turns it into:
# #line

I have encountered following bug when using commentary.vim to comment a block of python code:

x = 12
#
y = 12

Do a Visual line selection for the whole file (set ft=python) with ggVG and press gc. Nothing happens. Removing the # symbol without deleting the line gc works again.

This occurs as long as the commented line is empty or does only contain whitespace:

x = 12
# non empty line: everything works as expected
y = 12

I have tested this with gvim 7.4.873 on linux and neovim v0.1.1-15 under OSX.

I was working on a file type I've never worked with and intuitively hit gcj two comment out two lines.

Result:

Error detected while processing function <SNR>40_go:
line    7:
E688: More targets than List items

This was a bit confusing because at first I did not expect commentary.vim to be the culprit.

Perhaps consider failing silently or provide context as to the reason of the failure.

In order to set a different commentstring for htmldjango files I had to create a ~/.vim/after/ftplugin/htmldjango.vim and set the commentstring from there because setting a filetype autocommand for it on vimrc would be overwritten by vim/ftplugin/html.vim

What am I missing?