開発したライブラリから MSDN のような API リファレンスを作成する

  • このエントリーをはてなブックマークに追加
  • このエントリーをはてなブックマークに追加

.NET の開発していて、作成したクラスやメソッドのヘルプファイルを作ることになったとしたら、Sandcastle で簡単に作成することができます。
しかも、MSDN のような API リファレンスが作成できます。
Sandcastle – Documentation Compiler for Managed Class Libraries – Home

インストール

http://sandcastle.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=13873
上記サイトから最新版をダウンロードします。
インストーラを実行してインストールします。
このままだとコマンドプロンプトを使うなど、作成するのに手間がかかるので、下記サイトからヘルプファイル作成のツールをダウンロードします。
Sandcastle Help File Builder – Home
上記サイトから最新版をダウンロードし、圧縮ファイルを解凍してインストーラを実行してインストールします。

ヘルプファイルを作成する

事前にソースにはコメントを適切に入れておきます。
スタートメニューから「Sandcastle Help File Builder」ー「Sandcastle Help File Builder GUI」を実行します。
File メニューの「New Project」にて保存先フォルダを指定しプロジェクトのファイル名を入力後、保存ボタンをクリックします。

Sandcastle1


Project Explorer ウィンドウ内の「Documentation Sources」を選択して右クリックし、「Add Documentation Source…」にて作成対象となるプロジェクトファイルを選択します。

Sandcastle2


次に、Project Property の設定します。
最低限として、下記プロパティを設定しておきます。
Help File
HelpTitle : ヘルプファイルのタイトルを入力する
HelpFileName : 出力されるファイル名を入力する
Language : 日本語(日本)
ツールバーのビルドターゲットを適切に選択します。
(対象となるプロジェクトがビルドされている方にします)
Documentation メニューの「Build Project」にてビルドします。

Sandcastle3


しばらくし、下記のようなログが出力されていれば完了です。
Build completed successfully at 08/15/2009 06:57 午後. Total time: 00:00:54.2813
Documentation メニューの「View Help File」ー「View Help File」にて作成したヘルプファイルが参照できます。

Sandcastle4

プロパティを設定することで、namespace などにもコメントを追加できます。
環境によってプロパティを設定してください。

関連記事:

コメントを残す

メールアドレスが公開されることはありません。

*

This blog is kept spam free by WP-SpamFree.