NDocを使う

メモ:

NDoc1.3.1-rev2-beta4を使用して、リファレンスを生成してみます。

最初に、VBの開発環境で「プロジェクトのプロパティ」から[コンパイル]タブを選択し、【XMLドキュメントファイルを生成する】をチェックしておきます。コメントには、XMLコメントを使用しコメントを記述します。(参照:コメントをXMLで書く)

リファレンスを作成する

NDocを起動し右上のAddボタンをクリックします。ここでは、対象となるアセンブリファイルとXMLドキュメントファイルを指定します。

{{< figure src=“/assets/img/vb/ndoc1.gif” alt=“ファイル指定” >}}

{{< figure src=“/assets/img/vb/ndoc2.gif” alt=“ファイル指定ダイアログ” >}}

画面中央の設定にある【SdkDocLanguage】をJapaneseに設定します。

ドキュメントの出力先は、【OutputDirectory】に指定します。

{{< figure src=“/assets/img/vb/ndoc3.gif” alt=“出力設定” >}}

各種設定が終わればコンパイル{{< figure src=“/assets/img/vb/ndoc5.gif” alt=“コンパイル”>します。

{{< figure src=“/assets/img/vb/ndoc4.gif” alt=“コンパイル” >}}