たそらぼ

日頃思ったこととかメモとか。

コードにTODOのコメントを埋め込むvimプラグインを作った。

コードの未実装の箇所に、「こんな感じで実装していこうと思います、リファレンスはこれです。」とTODOのコメントを入れるvimプラグインを作りました。
github.com

インストール

{packpath}/pack/plugins/start 配下にgit cloneしてください。

dein.vimを使っている方は、dein.tomlなどに追記してインストールしてください。

[[plugins]]
repo = 'tasotasoso/vim-TodoComment'

dein.vimの使い方は本家レポジトリやさくらのナレッジの記事を参照のこと。

使い方

1. vimのnormalモードで :TodoComment を入力する。
2. コメントの入力を促されるので、任意のコメントを入力する。
3. コメントの根拠になるURLの入力を促されるので、ドキュメントなどのURLを入力する。

f:id:tasotasoso:20200829154353p:plain
実行結果

コメントアウトの種類について

コメントアウトに使う文字は、TodoCommentコマンドを実行するファイルの拡張子を読み込んで、自動的に変更される。
対応言語は以下になる。

extension comment out
py, rb, js, sh #
java, go, cpp //
others "