Skip to content

Add a string that marks inserted comments #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
idbrii wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a string that marks inserted comments #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71c3322
Add some locals to make surroundings() decipherable
idbrii Jul 20, 2021
5348669
Add a string that marks inserted comments
idbrii May 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/commentary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
14 changes: 12 additions & 2 deletions plugin/commentary.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,19 @@ 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
return split(get(b:, 'commentary_format', substitute(substitute(substitute(
\ &commentstring, '^$', '%s', ''), '\S\zs%s',' %s', '') ,'%s\ze\S', '%s ', '')), '%s', 1)
" 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

function! s:strip_white_space(l,r,line) abort
Expand Down