2009-07-21 29 views
1

私たちは徐々にASP.NET + VB.NETコードベースにリファクタリングするASP時代の非常に古いアプリケーションを持っています。ASP.NET + VB.NETアプリケーションのコードドキュメント

これは、以下の種類のファイルがたくさん含まれています

ASPX、ASMX、ASCX、VB、JS(JavaScriptの)、HTML、VBS(VBScript)を。

バックエンドデータベースは、多くのsprocsを持つSQL Server 2005です。

コードファイル内のコメントからコードドキュメントを自動的に生成したいと考えています。私はDoxygenを非常に好きでしたが、上記の技術をサポートしていないようです。いくつかのドキュメント生成ツールをお勧めします。できれば単一のツールまたはツール群をお勧めしますか?

ありがとうございます。

Ajit。

+0

お返事ありがとうございます。私自身、サンドキャッスルを大いに利用しています。 SandCastleは主にAPIドキュメンテーションツールであり、アセンブリ(DLL)をとり、さまざまなタイプのメンバーでドキュメントを生成するため、SandCastleは私にとってはうまくいかないでしょう。私は、上記の技術に属するソースコードファイルからコメントを抽出し、depencyグラフをファイルから探し出すことを探しています。私は上記の技術のためにDoxygenのような比較ツールを使いたいと思う。再度、感謝します。 –

答えて

2

Microsoft's Sandcastleツールをご覧ください。私は何度も使用してきましたが、.NETコードで提供されているコメントに基づいてドキュメントを生成します。正しく覚えていれば、JavaScriptライブラリのドキュメントを生成することもできます。

0

いくつかはそこにあります。

SandCastle

NDOC

+1

@Ajit&@Jimmy:NDOCは非常に古いツールです(約4年)。もうメンテナンス中ではありません。あなたがそれを使用しないならば、より良い。 – Kirtan

+0

ああありがとう。私は二次的な選択肢を探していました。私の以前の会社では、SandCastleもdocをやってみました。 –

0

私はSandCastleを使用しましたし、あなたのコード内のXMLコメントがあれば、それはあまりにも良い作品。

まず、プロジェクトのプロパティ - >コンパイル - > XMLドキュメントの生成で、xmlドキュメントをプロジェクトで有効にします。

完了したら、警告をエラーとして扱う必要があるかもしれないので、スタジオはどこに、そしてすべてのXMLコメントがないかを指摘することができます。

XMLコメントを追加するには、クラス定義や関数定義の前にカーソルを置き、作業が完了したら、これは自動的にその後、ドキュメントのXMLタグを生成します

///

を入力し、プロジェクトをインポートしてドキュメントの作成を開始できます。

あなたのクラスをうまく文書化しておけば、マウスの上にあるアプリケーションでこれらの関数を使用すると、intellisenseドキュメントの仕組みと同様に記述した説明を見つけることができます。

他の問題が発生した場合はお知らせください。

私の最後の提案は、こんにちは世界のプロジェクトとXMLを文書化し、それを使って砂浜に慣れてください。

関連する問題