読者です 読者をやめる 読者になる 読者になる

いろいろ備忘録日記

主に .NET と Python絡みのメモを公開しています。

Sandcastle, Sandcastle Help File Builder

以下、メモ書きです。


C#XMLドキュメントコメントを書く事は、多いですが実際に生成されるのはただのXMLファイルです。


そのXMLファイルからMSDNみたいなAPIリファレンスを作成してくれるのが、Sandcastleです。
ちなみに、これMicrosoft製です。


この分野で有名だったのがNDocというオープンソースのライブラリだったのですが、開発が事実上
終了してしまっています。(有志の方が日本語版を作成しておられます。しかも少し設定を編集することで
v2.0でも動くみたいです。)


で、このSandcastleですが、そのまま使うとすごく面倒くさいです。
何個もの手順をふまなければならないみたい。


で、それを簡単にできるツールを作成してくれている方がいます。
Sandcastle Help File Builderという名前のツールです。


使い方は、見たら大体わかると思いますので割愛します。
基本的に、ソリューションファイルを読み込んで、ドキュメントを生成するのが
一番楽なのではないでしょうか。


以下、それぞれのリンクをメモ。


でも、ドキュメント作成にすごく時間がかかります・・・・