Revision 2 as of 2012-08-08 02:15:30

Clear message
Locked History Actions

CS

C#

JavaDoc

C#ではJavaDoc相当のドキュメントを作成するには、以下の手順を踏む。

Visual C#での設定

  • ソースコードに「///」で開始するXMLのコメントをつける。
  • Visual C#のプロジェクトプロパティの「ビルド」タブで、XMLドキュメントファイルにチェックを入れ、出力ファイル名を指定する。
  • ビルドする。

これでソースから抜き出されたxmlファイルが生成されるが、そのままではドキュメントにならない。

Sandcastleのインストール

C#用の処理系としてNDocがあるが、現在のバージョンには対応していない。 ここではSandcastle使うことにする。以下からSanscastle Help File Builderをダウンロードし、Zipを解凍して中の SandcastleInstaller.exeを実行する。

実行途中でHtml Help 1 Compilerをインストールしなければならなくなるが、このありかがリンク切れ。

Sandcastle自体の使いかたは以下を参考にする。