makeCommentのご紹介

ma2 — Sat, 23 Aug 2008 00:38:00 GMT

大阪勉強会がWMコマ充/twitter部充だったりするので、さみしいです。

さみしいと言えば、過去に公開したVS2005(以降もリビルドで対応可能)のアドインmakeCommentを公開したときにさみしかったなと思いました。
C/C++にDoxygen形式のコメントをボタンひとつで挿入するアドインは"DoxyComment"が先にあったものの、スベるツールではないと思っていました。

で、スベらないようにするにはどうすればいいかを考えてみました。
とりあえず、

｢ツール作ったよ!!｣とエントリ書くだけでは投げっぱなしかも。

と、結論付けて、いつかきちんと紹介する決意だけしておきました。
そんなわけでmakeCommentの紹介です。

makeCommentは、VS2005/2008で動作するアドインです。
C/C++のソースコードにDoxygen形式の関数ヘッダおよびヘッダコメント(ファイルの先頭に記述するそのファイルの説明)の雛形を挿入します。
導入は手動で行う必要がありますが、小規模なツールなので少しの手間で済みます。

アーカイブから、*.addInと*.Dllと*.xmlをユーザーフォルダ(もしくはマイドキュメント)の./Visual Studio 2005/Addinsフォルダに配置します。
例) C:\Users\name\Documents\Visual Studio 2005\Addins ... 赤字の部分はユーザ名です

アドインフォルダは、VS2005のインストール直後にはありません。

次に、VS2005を起動します。
メニューから[ツール]→[アドインマネージャ]を選択します。

"makeComment"が使用できるアドインとして表示されます。
"使用できるアドイン"列の項目にチェックを入れるとアドインが使えるようになります。
とりあえず、[ツール]メニューの最上段に項目が増えます。

ツールバーに入れたり、ショートカットキーを割り当てたりもできます。

次に、C/C++のプロジェクトを開きます。
ソースファイルもしくはヘッダファイルを開いてコメントを挿入したい関数の定義行にキャレットを置き、先のメニュー項目を選択します。

@briefの入力を求められます。この入力は必須ではありません。

@briefを入力して、OKを押すと以下のような関数ヘッダが挿入されます。

@brief以外は入力が手動での必要です。
ファイルの先頭行で実行するとヘッダコメントが挿入できます。

コメントの上下にある'//*****'が不要な場合などは、導入のときに配置したxmlファイルで形式をカスタマイズできます。
ヘッダコメントの@authorに、記入する名前もカスタマイズできます。

以上がmakeCommentの紹介になります。

歴史あるプロジェクトに関数ヘッダを入れる簡単なお仕事、みたいなのがたまにあります。
これまでテンプレをテキストファイルなどに保存しておいて、それをコピペして@briefや@paramを編集していました。
引数の名前や返り値の型は、IntelliSenseの情報から取得します。

さみしくなるツールではないはずなので、日の目を見るといいなー・・・。

makeComment 0.8

ma2 — Thu, 17 Jul 2008 01:21:00 GMT

VisualStudio2005アドインです。
C/C++でのコメント入力を楽にします。

コンストラクタとデストラクタそれぞれ100個ぐらいにコメントを入れないといけないと言う苦行に直面したので、手抜きのために作りました。
VS2008だとVCCodeModelのバージョンが上がっているのでリビルドしないといけませんが、とりあえず使えます。

makeComment 0.7 - VisualStudio2005アドイン

ma2 — Sat, 17 May 2008 00:40:00 GMT

ずいぶん前からDoxygen形式のコメントをボタンひとつで入れられないかなー、と思っていました。
で、VCCodeModelというものがあるとかで、C#の勉強がてら作ってみました。

makeComennt 0.7(mkCmt_0.7.zip)

つたないところもあるかもしれませんが、フィードバックなんぞあればうれしいなと思ったり思わなかったり。