NDoc
■■説明
.Net用ドキュメント作成ツール。JavaDocの.Net版
■必要アプリ
.Net Framework
■ダウンロード場所
http://sourceforge.jp/projects/ndoc-jp/
ndoc-jp-installerをダウンロード
■インストール方法
Windowsインストーラを実行
■使い方
VS.Netでソリューションエクスプローラー
→プロジェクトのプロパティ
→構成プロパティ
→ビルド
→xmlファイルドキュメントにファイル名を設定
(プロジェクト名.xmlとした)
NDocを実行
Add->Assemblyで出力したいexeまたはdllを選択
SdkDocLanguageをJapaneseに設定
Documentation->buildを実行
"C:\Program Files\NDoc 1.3.1\bin"の直下にDocフォルダが出力される
【自動化】
VS.Netでソリューションエクスプローラー
→プロジェクトのプロパティ
→共通プロパティ
→ビルドイベント
→ビルド後イベントコマンドラインに以下を設定
ビルドが正常にできることを確認
プロジェクトのパス\bin\Debugにdocフォルダができている
■リファレンス
タグの詳細な意味はhttp://ndoc.sourceforge.net/usersguide.htmlを参照
↓はサンプル
↑を書くと↓となる
■コメント
.Net用ドキュメント作成ツール。JavaDocの.Net版
■必要アプリ
.Net Framework
■ダウンロード場所
http://sourceforge.jp/projects/ndoc-jp/
ndoc-jp-installerをダウンロード
■インストール方法
Windowsインストーラを実行
■使い方
VS.Netでソリューションエクスプローラー
→プロジェクトのプロパティ
→構成プロパティ
→ビルド
→xmlファイルドキュメントにファイル名を設定
(プロジェクト名.xmlとした)
NDocを実行
Add->Assemblyで出力したいexeまたはdllを選択
SdkDocLanguageをJapaneseに設定
Documentation->buildを実行
"C:\Program Files\NDoc 1.3.1\bin"の直下にDocフォルダが出力される
【自動化】
VS.Netでソリューションエクスプローラー
→プロジェクトのプロパティ
→共通プロパティ
→ビルドイベント
→ビルド後イベントコマンドラインに以下を設定
"C:\Program Files\NDoc 1.3.1\bin\NDocConsole.exe " "$(TargetPath)" -SdkDocLanguage=ja
ビルドが正常にできることを確認
プロジェクトのパス\bin\Debugにdocフォルダができている
■リファレンス
タグの詳細な意味はhttp://ndoc.sourceforge.net/usersguide.htmlを参照
↓はサンプル
/// <summary> /// 概要を記述 /// </summary> /// <example> コード例を記述 /// <code> /// class MyClass /// { /// public static int Main() /// { /// return GetZero(); /// } /// } /// </code> /// </example> /// <exception cref="System.Exception">例外の条件</exception> /// <param name='i'>引数の説明</param> /// <permission cref="System.Security.PermissionSet">Everyone can access this method.</permission> /// <remarks> /// You may have some additional information about this class. /// </remarks> /// <returns>Returns zero.</returns> /// <seealso href="URL">[label]</seealso> /// <preliminary> /// <para>This method is just for testing right now. It might be removed in the near future</para> /// </preliminary> /// <event cref = "イベントの種類を記述" > /// イベントの理由 /// </event> public int TestMethod(int i) { return 0; }
↑を書くと↓となる
■コメント
2006年01月02日(月) 17:57:12 Modified by ginjiginji
添付ファイル一覧(全1件)
391aae06da08e1c6.jpg (52.27KB)
Uploaded by ginjiginji 2006年01月02日(月) 17:51:32
Uploaded by ginjiginji 2006年01月02日(月) 17:51:32