Pebble Coding

プログラマーの作業メモ

doxygen形式の関数コメントを生成するvim plugin(C、Objective-C対応)

Vim Advent Calendar 2013 29日目の記事です。こんにちは@pebble8888です。
昨日は@kobadesuさんのはてなブログへVimからポストする でした。

普段のプログラミング作業で、関数のdoxygenコメントを書く時間をなんとか短縮できない かと思い、ひな形コメントを出力するvim plugin
doxygen comment creator
を作ってみました。C、Objective-C対応版です。

同じ機能を実現するC、C++python対応版のvim pluginとしては、 DoxygenToolkit.vim というものがすでにあります。
また、Objective-C対応版としてXcodeプラグインという形で、 VVDocumenter-Xcode というのもあります。

ですが、私の場合、Objective-Cソースを書くときは、Xcode(+XVim)とMacVimの使用頻度が同じくらいなので、MacVim上で動作するものが欲しいのです。

私はvim scriptの知識が全然足らないヘタレVimmerなので、今回はほぼrubyで書きました。まあrubyも得意ではないのですが。
この程度のpluginならrubyで書けるものなんだなあと分かったのが意外な収穫でした。

<インストール>
https://github.com/pebble8888/doxygen_comment_creator からBundleなどで入れたあとsh install.shを実行します。
<使い方>
Objective-Cメソッドの行にカーソルがある状態で「,d」とタイプします。

f:id:pebble8888:20131222223643p:plain


すると、こんなコメントが挿入されます。

f:id:pebble8888:20131222223832p:plain


[追記2014-07-01]
現時点で問題なく動作しています。
<おまけ>
以前紹介したsmartgrep.vimですが、 基準フォルダを.vimrcにグローバル変数で指定する方式はオプションに格下げし、git,hgのリポジトリを検出して、そのルートフォルダを 基準フォルダとして使う方式をデフォルトにしました。
個人的には、これでだいぶ使いやすくなったと思います。

今後もしばらくはC++/Objective-Cを書きまくる予定なので、道具を磨いて来年に備えたいと思います。
それではみなさんよいお年を。