| NDoc | |
|---|---|
 NDoc 1.3.1 が空のプロジェクトを表示 | |
| 開発者 | ダイアモンド、マノリ、他 |
| 安定版リリース | 1.3.1 / 2005年1月25日 |
| オペレーティング·システム | クロスプラットフォーム(?) |
| タイプ | ドキュメントジェネレーター |
| ライセンス | GNU GPL |
| Webサイト | ndoc |
NDocは、Jason Diamond、Jean-Claude Manoli、Kral Ferchによって開発された、共通言語基盤（Common Language Infrastructure）用のコードドキュメント生成ツールです。GNU General Public Licenseに基づいてライセンスされています。
仕組み
NDoc はドキュメントを生成するために2つのソースを使用します。1つはソースコードをコンパイルして生成されるアセンブリファイルです。もう1つは、通常はソースコードから特殊なコメントを解析して生成される、事前に生成されたXMLドキュメントファイルです（ .NET FrameworkおよびMonoのC#コンパイラは、コマンドライン引数 " " を使用してこれをサポートしています）。/doc
アセンブリ ファイルはリフレクションを使用してクエリされ、クラス、メソッドなどのリストが取得されます。XMLファイルはドキュメント テキストについて解析されます。
NDoc は、 CHM、Microsoft ヘルプビューア、MSDNスタイルのウェブページなど、様々な出力形式をサポートするためにプラグインを使用しています。開発者向けの出発点として、 LaTeXプラグインやJavadocスタイルのウェブページなど、不完全なプラグインも含まれています。NDoc には、生成プロセスを容易にする グラフィカルユーザーインターフェースが付属しています。
限界と将来の発展
NDocの最新リリース版は.NET Framework 2.0をサポートしていません。.NET 2.0をサポートする内部アルファ版[ 1 ] [ 2 ]は存在しますが、2006年現在、NDocプロジェクトの活動は非常に少ないです。NDocの開発者であるKevin Downs氏は、資金不足と自身への脅迫のため、NDocの開発を中止し、プロジェクトの管理を引き継ぐ用意があると表明しています[ 3 ] 。 最近では、Kim Christensen氏が引き継ぎ、オリジナルのNDocをNDoc3として開発を続けています[ 4 ]。
参照
- Doxygen - クラス ダイアグラムを構築し、他の多くの言語からドキュメントを生成することもできる、成熟したドキュメント生成ツールです。
- Sandcastle — Microsoftによる同様のアプリケーション。
- Sandcastle ヘルプ ファイル ビルダー— Ndoc のような機能を提供する Sandcastle 用のフリーウェア GUI フロントエンド。
- Visual Expert -コールツリー、CRUD マトリックス、影響分析、PL/SQL、Transact-SQLおよびその他の言語のコードレビューも提供するドキュメント ジェネレーター。
- ドキュメントジェネレータの比較
参考文献
外部リンク
