Visual Studio Code で ctags を使う

Visual Studio Code で ctags を使う方法について記載する。

最も様々なプログラミング言語の解析ツールが充実しているVSCodeでctagsを使う必要があるマイナー言語を使うこと自体が避けられればよいのだが。

ctags とは

ソースコードの名前のインデックスファイル(タグファイル)を生成するプログラム。
タグファイルを参照することでエディタで関数、変数の定義を検索し、移動できる。

エディタで解析機能に対応していない場合もctagsで宣言場所に移動できる。

ctags Wikipedia

Universal CTags

様々な言語に対応した Ctags生成ツール

Universal CTags 公式サイト

Windowsバイナリ

Chocolatey でのインストール

choco install universal-ctags

Visual Studio Code での ctags の利用

事前に Universal CTags をインストールしておく。

Visual Studio Code の拡張で CTags Support (ctags-support) をインストールする。

対象となるフォルダでタグファイル生成のコマンドを実行する。

ctags -R --input-encoding-sql=Shift_JIS --output-encoding=UTF-8 -f .tags

これにより、Ctrl+Tでタグジャンプができるようになる。

.ctags の利用

Visual Studio Code で対象フォルダの直下に設定ファイル .ctags を作成する。

• 除外フォルダの指定
• 除外ファイルの指定
• 入力文字コードの指定
• 出力文字コードの指定
  などが可能である。

.ctags 例

ctags --exclude=node_modules/* --exclude=.git/* --exclude=*.css --exclude=*.json -R --input-encoding-sql=Shift_JIS --output-encoding=UTF-8 -f .tags