概要と特徴 - VBDOX日本語化 Wiki - VBDOX日本語化

Up: VBDOX日本語化Wiki トップ

Prev: VBDOX日本語化Wiki トップ

Next: スクリーンショット

概要と特徴

概要

VBDOXは、ソースのコメントからの技術ドキュメントを生成する単純なプログラムです。唯一必要な要件は、モジュールや関数の特定のコメント形式を使用することです。ドキュメントは、VBScriptおよびASP(※制限あり)を含むすべての種類のVisual Basicファイル向けに生成されます。

プログラムは異なったドキュメント用コメントやレポートに対応するように拡張することができます。現在、VBDOXには3つのレポートジェネレーターがあります：Simple 、 XML 、MSDN Platform SDKスタイル（訳注：たぶん、文書（原文）が古い。実際には.NET 形式と、RTF形式もあります）。スタイルシートかレポートファイルのどちらかを変えることによって、レポートの外観を編集することができます。現在、数個のドキュメント用コメントパーサを提供しています。

Basicでないファイルフォーマットにも対応できるように拡張可能です。(例えば、ABB RAPID ソースファイル)

ユーザ定義辞書を使用可能な統合スペルチェック

VBDOXはVisual Basic 6.0で作成されていますが、依存度は最小限にしています。VBDOXのインストールは、ダウンロードしたZipファイルを解凍するのみと、非常に簡単です。アンインストールについては、まず、「Tools」メニューから「Unregister components」を選択し、作成されたディレクトリを削除することで行います。

Version 2 より、VB.NET と C#を(ベータ)サポートしています。

sourceforge.net上のHP(英)も見てください。

特徴

• Visual Basic, ASP や VBScript のAPIドキュメントの自動生成
• Microsoft Platform SDK 形式のドキュメントの出力
• Microsoft HTML Help Workshop プロジェクト、コンテンツ、インデックスファイルの自動生成
• レポートとドキュメントスタイルの拡張が可能
• XML や RTF 形式のレポートの出力
• スペルチェック(ユーザ辞書)

サポートしているファイルの種類

• Visual Basic プロジェクトファイル(*.vbp)
• Visual Basic グループファイル(*.vbg)
• Visual Basic モジュールファイル(*.frm,*.bas,*.cls,*.ctl)
• VBScript ファイル(*.vbs)
• Active Server ページファイル(*.asp,*.asa)
• Visual Studio マクロファイル(*.dsm)
• Visual Basic .NET プロジェクトファイル(*.vbproj)
• Visual Basic ソースファイル(*.vb)
• Visual Studio ソリューションファイル(*.sln)
• Visual InterDev プロジェクトファイル(*.vip)
• C# プロジェクトファイル(*.csproj)
• C# ソースファイル(*.cs)
• ABB RAPID ソースファイル(*.mod;*.sys)

このドキュメントはVODOX(英)のサイトを元に作成しました

Up: VBDOX日本語化Wiki トップ

Prev: VBDOX日本語化Wiki トップ

Next: スクリーンショット