A p p Application Architecture for .NET の利用例 l i c a t ヘルプを用意する i 第１１回株式会社CSKシステムズ IT生産技術部中垣健志 o NAKAGAKI, Kenji n えるでしょう。その中でも.NET Fra A 開発者が一番多く見るドキュメントは？ meworkで用意されたクラスライブラ r リのリファレンスは、とくによく参照 Soarリファレンスヘルプを作成するされるドキュメントです。Visual Stu Soarリファレンスヘルプを作成す h ミングを行なう際に、頻繁に参照する dioでプログラムを作成しているときるにあたって、Wordなどでヘルプ用 i ドキュメントは何でしょうか？多くに、クラスの概要、プロパティやメソの文書を別途作成する必要はありま t の開発者は「MSDNライブラリ」と答ッドの一覧、定義されている属性なせん。Soarリファレンスヘルプに必どを確認したいと思ったら、［F1］キ要な情報は、すべてソースコードからーを押せば確認したいクラスのヘル取得します。クラスやメソッドの定義プを表示することができます。そのものも、プログラムから自動的 e c .NET Frameworkを使ったプログラ c Level t 1 2 3 4 5 Soarフレームワークを使う開発者に取得します。定義されたオブジェクトに関する説明は、ソースコードに r 意されたクラスライブラリのリファレ記述したドキュメントコメントから作 e u にとっても、Soarフレームワークで用 Technology Tools Visual Basic ンスは必須の機能となります。でき成します。ソースコードやドキュメン Visual C# れば.NET Frameworkと同様に、プトコメントで記述した情報は、一度ログラミングの最中にテキストエディ所定の形に沿ってXMLファイルに変タと連携して即座に確認できれば非換されます。このXMLファイルから常に便利です。そこで今回は、Soar ヘルプファイルを作成し、作成したヘフレームワークで用意したクラスラルプファイルをVisual StudioへSoar イブラリのリファレンス（以下Soarリリファレンスヘルプとして登録するとファレンスヘルプ）を作成し、MSDN いう流れになります。 Visual C++ f SQL Server o Oracle r Access ASP.NET Other: . N Visual Studio .NET 2003 VBCommenter E NDoc T Help Integration Wizard Beta ライブラリに組み込む方法について見ていきたいと思います。ただしVisual Studio標準の機能だけでは、ソースコードからSoarリファレンスヘルプを作成することができません。そこで今回は、表1に示す 160 Windows Developer Magazine ヘルプを用意する T 表1：ソースコードからリファレンスヘルプを作るためのツール VBCommenter VB.NETでドキュメントコメントを作成する（C#では不要）入手先 http://www.gotdotnet.com/workspaces/workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd N E 概要ドキュメントコメントからヘルプファイルを作成する入手先 http://ndoc.sourceforge.net/ http://sourceforge.jp/projects/ndoc-jp/（日本語対応） r 概要 . NDoc Help Integration Wizard Beta ヘルプファイルをVisual Studioに組み込むインストーラを作成する入手先 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dv_vstechart/html/integration_wizard.asp e Soarリファレンスを作成することにします。ントからXMLファイルを作成することができます。Vis ual Studioで Soarフレームワークのソリューションを開いたら、ドキュメントコメントを作成したプロジェクト法は、VB.NETであるかC#であるかによって少し違いまのプロパティ画面を開きます。そして、左側のツリーかす。そこで以降では、言語別にその方法について説明しら「構成プロパティ」-「ビルド」を選択します。「XML ていきます。ドキュメントファイル」という項目があるので、そこへ r VB.NETの場合は、Visual Studioの機能ではドキュメァイル名を設定します。特別な理由がない限り、通常は「アセンブリ名.xml」としておきます（図2）。以上の設定を行なうことで、プロジェクトをビルドすせん。そこで、VBCommenterを使ってドキュメントコるたびにドキュメントコメントが、アセンブリが生成さメントからXMLファイルを作成します。VBCommenter れるフォルダと同じ場所に XMLファイルとして作成さはMicrosoftが自社で運用しているGotDotNetというサれます。 o n ントコメントからXMLファイルを作成することができまイトで公開されているツールです。ライセンスに従う限 i 図1：VBCommenter設定ダイアログ t りは、商用／非商用を問わず利用することができます。 A ◆VB.NETの場合 c ドキュメントコメントが出力される XMLファイルのフ h i t e ドキュメントコメントからXMLファイルを作成する方 t C#の場合は、Visual Studioの機能でドキュメントコメ u r ◆C#の場合ドキュメントコメントから XMLファイルを作成する f 名前のXMLファイルとして作成されます。 c いくつかのβ版ツールとオープンソースを組み合わせて o 概要 a VBCommenterをあらかじめインストールしておきます。インストールが成功しているとVisual Studioの［ツ c ール］メニューの中に［VBCommenter Options］とい i う選択肢が現われます。これを選択すると図1のダイア l ログ画面が開くので、「Create .xml files when projects p are built」というチェックボックスにチェックします。 p 以上の設定を行なうことで、プロジェクトをビルドす A るたびにドキュメントコメントが、プロジェクトファイルと同じフォルダにプロジェクトのアセンブリ名と同じ 2006 March 161