C＃/API Document for 2.0 のバックアップ(No.1)

バックアップ一覧
差分を表示
現在との差分を表示
ソースを表示
C＃/API Document for 2.0 へ行く。
- 1 (2007-02-05 (月) 21:50:55)
- 2 (2008-03-14 (金) 17:33:26)

Sandcastle の勧め †

　Visual Studio .NET 2003 の頃は、APIリファレンスの作成にはNDoc?を使えばよかったです。しかし、.NET Frameworkが2.0(or 3.0)になってからは、Generics未対応とか、MSDNのBCL(Basic Class Library)へのリンク先が古いままとか、いろいろ不都合が起きました。で、暫定的な NDoc 2005 を使わせて頂いてみても、対応はイマ一歩（ノーブレークスペースの為に多用している文字コード[&#160]が、日本語コードページ上では文字化けしてしまう & Generic対応不十分）で、業務用には使いにくかったりしたわけですよ。
　さらに、NDoc 2.0はリリースされないということですから、どうすりゃいいのか？と思っていたら、MicrosoftがSandcastle ってドキュメントコンパイラを開発してくれているようです。

　本体はCUIのみなので、バッチ(make_doc.bat)を作るのがいいかな、と思ってたら、別途 Sandcastle Help File Builder ってGUIがありました。この組み合わせは非常に好い！このGUIの操作性は、完全にNDocGUI互換です。

NDoc同様、chmファイルを生成できるが、MSDN formatとは異なる。
- 単なる継承メンバを省略できたり、コード形式をC#, VB.NET, C++.NETから選択できたりする。
コメント文中の日本語は正しく表示される。ツール自体は日本語未対応。
Genericも正しく出力される。
基本クラスについては、MSDNv2へのリンクを付加できる。
GACに含まれるアセンブリへの参照設定も、簡単にできる。
動作には、.NET Framework 2.0とHTML Help Workshop が必要。
2007.02.05現在のバージョンは December 2006 CTP で、まだリリース版ではないが、既に大きな障害はなくなってるんじゃないかなぁ…

　これで、.NETのドキュメントコンパイラ問題は、解決だねっ！ (^o^)/