karakaram-blog

Vimのコメントアウトプラグインtcommentを試す

 ツイート 0  シェア 0  Google+1 0  Hatena 1

vim-logo

Vimでソースコードをコメントアウトしたり、コメントアウトを解除できるプラグインを探したところ、Vimテクニックバイブルでtcommentが紹介されていたので試してみました。

この記事では、コメントをトグルする方法と、標準で対応していないfiletypeのコメント書式を定義する方法について紹介します。

動作確認環境

  • Vim7.3
  • tcomment2.06

目次

  1. ダウンロードとインストール
  2. コメントをトグル
  3. サポートされていないfiletypeのコメント書式を定義

ダウンロードとインストール

下記よりダウンロードします。本記事作成時点の最新バージョンは2.06です。
https://github.com/tomtom/tcomment_vim/tags

インストールは、pathogen/bundle系プラグインを導入していれば~/.vim/bundle/ディレクトリに展開するだけでOKです。

インストール時の問題点

バージョン2.06をインストールしたところ、私の環境では下記のエラーが出ました。

E154: Duplicate tag "g:tcommentBlockC" in file ~/.vim/bundle/tomtom-tcomment_vim-2dded3e/doc/tcomment.txt

tomtom-tcomment_vim-2dded3e/doc/tcomment.txt の108行目付近と290行目付近に g:tcommentBlockC に関する記述の重複があります。重複部分を削除したところ、エラーは出なくなりました。

コメントをトグル

キーマップがデフォルトでいろいろ定義されていますが、私は 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のコメント書式を定義しています。

 ツイート 0  シェア 0  Google+1 0  Hatena 1