C＃/API Document for 2.0 のバックアップソース(No.2)

バックアップ一覧
差分を表示
現在との差分を表示
バックアップを表示
C＃/API Document for 2.0 へ行く。
- 1 (2007-02-05 (月) 21:50:55)
- 2 (2008-03-14 (金) 17:33:26)
* [[Sandcastle:http://blogs.msdn.com/sandcastle/]] のススメ [#qd97b9c4]
#ref(chm.png,around,right,nolink);
　Visual Studio .NET 2003 の頃は、APIリファレンスの作成には[[NDoc>C＃/ドキュメント作成]]を使えばよかったです。しかし、.NET Frameworkが2.0(or 3.0)になってからは、Generics未対応とか、MSDNのBCL(Basic Class Library)へのリンク先が古いままとか、いろいろ不都合が起きました。で、暫定的な [[NDoc 2005:http://sourceforge.net/projects/ndoc05/]] を使わせて頂いてみても、対応はイマ一歩（ノーブレークスペースの為に多用している文字コード[&#160]が、日本語コードページ上では文字化けしてしまう & Generic対応不十分）で、業務用には使いにくかったりしたわけですよ。
　さらに、[[NDoc 2.0はリリースされない:http://www.charliedigital.com/PermaLink,guid,95b2ab68-ba92-413a-b758-2783cde5df9c.aspx]] ということですから、どうすりゃいいのか？と思っていたら、Microsoftが[[Sandcastle:http://blogs.msdn.com/sandcastle/]] ってドキュメントコンパイラを開発してくれているようです。

#clear

#ref(SandcastleBuilder.png,around,left,nolink);
　本体はCUIのみなので、バッチ(&ref(make_doc.bat);)を作るのがいいかな、と思ってたら、別途 [[Sandcastle Help File Builder:http://www.codeplex.com/SHFB]] ってGUIがありました。この組み合わせは非常に好い！ このGUIの操作性は、完全にNDocGUI互換です。

#clear

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

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

*** 私的な設定 [#w14f47a0]
- 利用したソフトウェア
-- [[Sandcastle(January 2008 Release):http://www.codeplex.com/Sandcastle]]
-- [[Sandcastle Help File Builder GUI 1.6.0.4:http://www.codeplex.com/SHFB]]
-- [[Microsoft HTML Help Workshop:http://msdn2.microsoft.com/en-us/library/ms669985.aspx]]
--- HTML Help 1.xの生成を目的とします。HTML Help 2.0は専用のViewerが別途必要なので嫌いです。
- 手順
++ 上記全てをインストールし、SHFBを起動
++ [Add]ボタンで、API Documentを出力するDLL,EXE,XMLファイルを指定する。
++ Build/Dependenciesに、参照が必要なDLL,EXEファイル、フォルダを指定する。
++ Build/HelpFileFormatを、「HtmlHelp1x」(Default)にする。
++ Help File/CopyrightHrefを記入する。
++ Help File/CopyrightTextを記入する。
++ Help File/HelpTitleを記入する。
++ Help File/HtmlHelpNameを記入する。
++ Help File/Languageを、「日本語（日本）」にする。
++ Help File/SyntaxFiltersを、「CSharp」のみとする。
++ Paths/HtmlHelp1xCompilerPathに、HTML Help Workshopのインストールパスを指定する。
++ Paths/SandcastlePathに、Sandcastleのインストールパスを指定する。
++ Show Missinf Tags/ShowMissingNamespacesを、「False」にする。
++ [Build Project]を実施する。