GhostDoc(C#/VBコメント入力支援)

このページではC#、VB.NETのコードコメント支援ツールであるGhostDocに関する説明を紹介します。

GhostDocとは

GhostDocはコードのコメントを簡単に管理するためのツールです。Submainのサイトからダウンロードすることができます。

GhostDocには無償のエディション「GhostDoc」と有償の「GhostDoc Pro」が存在します。有償のProエディションは、個人の場合$30、商用の場合$50です。(バージョンアップをサポートする場合はさらに$25がプラスとなります。)Proエディションではファイルヘッダー、クラスヘッダー、T4テンプレートでの生成がサポートされます。

ここでは、無償のGhostDocについて紹介します。

GhostDocが便利な理由

Visual Studioではスラッシュを3回書くだけでコメントを書けますが、そのひな形は空っぽで作られます。しかし、Page_LoadやForm_Loadのようなイベントでは何回も似たようなコメントを書かなければいけません。その点、GhostDocを使用すれば、各イベントにデフォルトのコメントを用意することができます。また、メンバ名や引数の型に応じて挿入メッセージを振り分けることができます。これによって、開発作業の軽減と、コメントの統一をできるようになります。

また、GhostDocにて入力されたコメントは、Sandcastleを使ってヘルプファイルを生成できるため、APIドキュメントマニュアルを簡単に作成できるようになります。

GhostDocのセットアップ

GhostDocは、Visual Studio 2005、2008、2010をサポートしています。セットアップは、インストーラーを実行するだけです。

GhostDocの使い方

コードエディタの右クリックメニューの「Document This」もしくは「CTL+SHIFT+D」ショートカットを利用します。これによって簡単にコメントを挿入・更新することができます。

GhostDocの日本語について

GhostDocで初期設定されている説明は英語となります。日本語バージョンは特に提供されていませんが、ツールのオプションから適宜設定していくことができます。

GhostDocの日本語設定サンプルとインポート

日本語が表示されるように幾つか設定したサンプルファイルを以下に公開します。

Japanese.gdc (zip形式にて圧縮)

このファイルをインポートすれば、よく利用されるメッセージが日本語化されるので、初めて利用する場合には理解しやすくなるかと思います。

設定ファイルをインポートするには、VSのツールメニューからSmartDocのオプションを開きIMPORTを選択します。

Express Editionについて

残念ながらGhostDocはVisual Studio Express Editionでは使用できません。Express Editionはアドインの拡張機能を提供していないためです。

最後に

GhostDocはコメントのひな形をカスタマイズできるというシンプルなツールですが、単純な作業を軽減できるため、コーディングを楽にしてくれます。定期的にバージョンアップされているツールですので、試しにインストールしてみてはいかがでしょうか。


ネクストスケープ企業サイトへ

NEXTSCAPE

検索する

タグ

メタデータ

投稿のRSS