最近よく見るようになったvimスクリプトのコメントの書き方

所有するサイトの関係上、相当な数のvimエディタのスクリプトを読んでいますが、
最近、このようなコメントの書き方をよく見かけるようになりました。

:if exists('loaded_undobranch_viewer')
    :finish
:endif
:let loaded_undobranch_viewer = 1

:command! -nargs=0 UndoBranchViewer :call s:UndoBranchViewer()

:function! s:UndoBranchViewer()
    :let g:undolistHandlers = [
        \ {'key': 16, 'agent': s:SNR().'AgentUndoPreview', 'key_name': '<c-p>', 'help': 'Undo preview'},
        \ {'pick_last_item': 0},
        \ ]
    :let s:undolists = tlib#cmd#OutputAsList('undolist')
    :call tlib#input#List('s', 'UndoBranch', s:undolists, g:undolistHandlers)
:endfunction

:function! s:AgentUndoPreview(world, selected)
    :return a:world
:endfunction

:function! s:SNR()
    :return matchstr(expand('<sfile>'), '<SNR>\d\+_\zeSNR$')
:endfunction

finish
==============================================================

スクリプトのコメントとか、
履歴とか記述。

「finish」と書いて、そこでスクリプトの読み込みを停止、
その後ろにコメントを書くらしい。

コメントアウトする手間もかからず、ハイライトも有効と。

流行ってるの？

Comments

そのスタイルはPerl辺りからの輸入ものだと思いますよ(man perlpod参照)。

Posted by kana at 2008年02月11日 21:16

なるほど

Posted by 小見 拓 at 2008年02月13日 01:21