Vimでソースコードをコメントアウトしたり、コメントアウトを解除できるプラグインを探したところ、Vimテクニックバイブルでtcommentが紹介されていたので試してみました。
この記事では、コメントをトグルする方法と、標準で対応していないfiletypeのコメント書式を定義する方法について紹介します。
動作確認環境
- Vim7.3
- tcomment2.06
目次
ダウンロードとインストール
下記よりダウンロードします。本記事作成時点の最新バージョンは2.06です。
https://github.com/tomtom/tcomment_vim/tags
インストールは、bundle 系プラグインを導入していれば ~/.vim/bundle/ ディレクトリに展開するだけでOKです。
コメントをトグル
キーマップがデフォルトでいろいろ定義されていますが、私は gc と gcc というマッピングしか使用していません。このマッピングでコメントのトグルが簡単にできます。
コメントの書式は、filetypeに応じて自動で変化します。
カレント行のコメントをトグルする
ノーマルモードで gcc と入力します。
選択した部分のコメントをトグルする
ビジュアルモードで gc と入力します。複数行のコメントや部分的なコメントをトグルすることができます。
サポートされていないfiletypeのコメント書式を定義
独自に定義したfiletypeやサポートされていないfiletypeでは、コメントの書式は/**/になっているようです。これを変更したい場合は.vimrcで下記のように記述します。
if !exists('g:tcomment_types')
let g:tcomment_types = {}
endif
let g:tcomment_types['phpunit'] = '// %s'
let g:tcomment_types['twig'] = '{# %s #}'上記の例では、filetypeがphpunitとtwigのコメント書式を定義しています。