APIリファレンスを作成

C#

[この記事は17年前に書かれました]

1)NDoc(日本語版)をダウンロードしてきて解凍。

http://sourceforge.jp/projects/ndoc-jp/
2)NDocを起動
3)Addボタンで、アセンブリを選択
4)「Documentation Type」タイプを選択(MSDN等)
5)その他、以下等を指定。 Output Target(「HTML Help」を選ぶと1つのファイルだけで構成されるファイルが出来ます。) SdkDocLanguage(Japaneseを選択)
6)「Documentation」→「Build」で「OutputDirectory」に指定したフォルダにAPIリファレンスが作成される。 
(※)HTML Helpは、HTML Help2 Compilerがインストールされていないとエラーになる。 ExpressEditonでは入ってません。別途インストール。 NDocで指定した設定は、NDocプロジェクトとして保存することができ再利用可能です。

  (注意).NETフレームワーク2.0環境ではBuild実行時にエラーになります。以下の設定で回避可能。 サイド・バイ・サイドでCLRを指定。NDocGui.exeと同じフォルダにNDocGui.exe.configを作成。

<?xml version="1.0"?>
<configuration>
<startup>
  <supportedRuntime version="v2.0.50727" />
</startup>
</configuration>

(※)NDoc1.3.1で検証

コメント

タイトルとURLをコピーしました