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の
【ハウツー】SandcastleでXMLドキュメントコメントからヘルプを生成する - HTML生成編 (1) XMLドキュメントコメントの書き方 | エンタープライズ | マイコミジャーナル
ヘルプドキュメントの作成 チームで開発をしている時に、共通部品のドキュメントがあれば良いのにと思ったことはありませんか。また、MSDNのようなAPIリファレンスを作成しなければいけない状況になったことはありませんか。 このような時にWordやExcelを使ってヘルプドキュメントを書くとなると、プログラムとの整合性を保つ必要があり多くの工数がかかります。そこで本稿では、ソースコードに記述したクラスやメンバの説明から、リファレンス形式のヘルプドキュメントを生成できる「Sandcastle(サンドキャッスル)」というツールについて紹介します。 構成について 本稿では、Sandcastleというソフトウェアを使って、.NETのソースコードに記述したコメントからヘルプファイルを生成する方法について紹介します。この前編では、以下の内容について紹介します。 ・Sandcastleの概要とXMLドキュメン
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
