Add a string that marks inserted comments

This marker is inserted immediately after the comment string. Useful if
commentary is only used to disable code (rather than inserting
explanatory comments).

For example,
    let g:commentary_marker = '~'
will comment
    f();
into
    //~ f();

Support a b: version because some filetypes (like dosbatch or python's
black) require whitespace after their commentstring.

Author: idbrii

doc/commentary.txt

@@ -29,6 +29,22 @@ gcu
                                                 *:Commentary*
 :[range]Commentary      Comment or uncomment [range] lines
 
+
+                                                *g:commentary_marker*
+g:commentary_marker     A string that marks comments inserted by commentary.
+                        This marker is inserted immediately after the comment
+                        string. Useful if commentary is only used to disable
+                        code (rather than inserting explanatory comments).
+                        
+                        For example, >
+                            let g:commentary_marker = '~'
+<                        will comment >
+                            f();
+<                        into >
+                            //~ f();
+<
+                        Use |b:commentary_marker| for a buffer-local override.
+
 The |User| CommentaryPost autocommand fires after a successful operation and
 can be used for advanced customization.
 

plugin/commentary.vim

@@ -8,10 +8,17 @@ if exists("g:loaded_commentary") || v:version < 703
 endif
 let g:loaded_commentary = 1
 
+if !exists("g:commentary_marker")
+  let g:commentary_marker = ''
+endif 
+
 function! s:surroundings() abort
   " Get commentstring with %s and whitespace padding.
   let cms = substitute(substitute(substitute(
         \ &commentstring, '^$', '%s', ''), '\S\zs%s',' %s', '') ,'%s\ze\S', '%s ', '')
+  " Postfix comment leader with marker to make auto commented code easier to find.
+  let marker = get(b:, 'commentary_marker', g:commentary_marker)
+  let cms = substitute(cms, '\S\zs\s*%s', marker ..'&','')
   let fmt = get(b:, 'commentary_format', cms)
   return split(fmt, '%s', 1)
 endfunction