.NET Tips: NDoc の紹介

2006年3月7日

■ NDoc の紹介
Visual Studio 2005 と "NDoc" というツールを使うことで、MSDN のような HTMLヘルプ形式 (.chm ファイル) を含む様々なヘルプ形式を出力できる。
NDoc は以下で入手できる。

• NDoc
  <http://ndoc.sourceforge.net/>
• NDoc 日本語版
  <http://sourceforge.jp/projects/ndoc-jp/>

<http://ndoc-jp.sourceforge.jp/>

■ NDoc 日本語版の導入方法
NDoc 日本語版を使うには、以下のような設定を行うと良い。

• Visual Studio 2005 側の設定
  • プロジェクトのプロパティの「ビルド」で「XML ドキュメント ファイル」を指定しておく。
• NDoc 側の設定
  • NDoc の日本語版の最新版をインストール (現時点 2006/03/07 では v1.3.1-rev2-beta4 または v1.3.1-rev1)。
  • NDoc は現時点 (2006/03/07) では、そのままでは .NET Framework 1.0 と 1.1 にしか対応していないため、下の内容で "NDocGui exe.config" というテキスト ファイルを作成し、NDoc をインストールしたフォルダの下の bin というフォルダに入れておく。
  • 日本語のヘルプ出力のためには、NDoc を起動して、設定の “SdkDocLanguage” を「日本語」に変更。

※ "NDocGui exe.config" の内容
<?xml version=”1.0″ ?>
<configuration>
<startup>
<supportedRuntime version=”v2.0.50727″ />
<supportedRuntime version=”v1.1.4322″ />
<requiredRuntime version=”v1.1.4322″ />
</startup>
</configuration>
参考:

• @IT ― C#でMSDNライブラリ風のAPIリファレンスを作成するには?
  <http://www.atmarkit.co.jp/fdotnet/dotnettips/185ndoc/ndoc.html>