Sandcastle Help File Builder を使って、ソースコードからドキュメントを自動作成しよう
Sandcastle というのは、ソースコードの構造やコメントを元に、ドキュメント(APIや内部説明書)を自動作成してくれるソフトです。 類似のソフトとして、doxygenやNDocがあります。 今回は、Sandcastle と 支援ソフトの Sandcastle Help File Builder の使い方について、簡単に説明します。 まずは概要 Sandcastleには、以下の特徴があります。 MSDN風のHTML Help形式(.chm)のドキュメントを作成してくれます。 .NET 2.0に対応しています。 Microsoft自身が対応してくれています。 VS SDK 4.0 December CTP に同梱されたり、単独で配布しています。 日本語を使っても大丈夫のようです。 Sandcastleについて、先行で調べてらっしゃる方については、以下が参考になると思います。 Kazzzの
自作したクラスライブラリのヘルプ（ドキュメント、仕様書）を作成する
自作したクラスライブラリのヘルプ（ドキュメント、仕様書）を作成する自作したクラスライブラリのヘルプ（ドキュメント、仕様書）を作成するのは面倒ですが、それを自動で作成してくれるツールがあります。これらのツールを使えば、ソースコードファイルに記述されたドキュメントコメントを基にして、MSDNのようなヘルプやHTMLを簡単に作成できます。ここではこのようなツールを幾つか紹介します。 なおここで紹介しているツール（「コードコメントWebレポート」以外）には、ソースコードファイルのドキュメントコメントを出力したXMLファイルが必要ですので、その作り方がわからないという場合は、まず「ドキュメントコメントにより型の概要をXMLファイルに出力する」をご覧ください。 Sandcastle Help File Builderを使用してヘルプを作成する現在最もメジャーなツールが、「Sandcastle Help
403 Forbidden
＼閉鎖予定のサイトも売れるかも？／ アクセスがないサイトもコンテンツ価値で売れる場合も… ドメインの有効期限を更新してサイト売却にトライしてみましょう
Sandcastleでドキュメントを作成する - bnote
ライブラリ等のドキュメントを生成します。インストール方法は、**Sandcastleをインストールする**を参考にしてください。(2007/06/20時点) 使用するSandcastleは、Sandcastle - June 2007 Community Technology Preview (CTP)です。 ドキュメントの作成 Sandcastleをインストールしたフォルダに、Examples\Sandcastleフォルダが作成されています。このフォルダには、C#のプロジェクトとドキュメントを生成するバッチファイルが用意されています。(build_Sandcastle.bat) 実際にドキュメントを生成する際は、このバッチファイルを修正して使用すると良いのではないでしょうか？ build_Sandcastle.batの中及び使い方 Sandcastleの各ツールのパスやHTML Help
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
bne.jp
