2

統合しようとしているアプリケーション用にベンダーの 1 つから提供された Web サービスのドキュメントを作成しようとしています。インターフェイスの束は、Web サービス自体で定義されたカスタム オブジェクトです。ベンダーは、このアプリケーションのドキュメントを提供することにかなりの抵抗を示したので、[私のより良い判断に反して] 彼らの仕事を自分で行うことにしました.

彼らが提供したドキュメントは率直に言って恥ずかしいものであり、私はこれをできる限り短くして、質の高いドキュメントをまとめようとしています. 私は彼らのソースにアクセスできないので、nDoc/Sandcastle を介して実行して API ドキュメントを吐き出すことはできないことを知っていますが、(中途半端な家として) 簡単な方法があるかどうか疑問に思っていました定義された各オブジェクト タイプを具体的に反復処理し、メンバーをテキストに反映するユーティリティを作成する必要なく、インテリセンスをテキスト ファイルにエクスポートするにはどうすればよいですか?

これができれば、少なくとも、空欄を埋めるだけの高品質のドキュメント構造が確実に得られるでしょう。すべてのクラス メンバーの IntelliSense をチェックするために Visual Studio を行ったり来たりしなければならないのは、これを行うのに非常に面倒な方法です。

誰にもアイデアはありますか？

4

7 に答える 7

6

文書化しようとしているのが Web サービスの場合、WSDL を解析できませんか?

于 2009-01-14T22:03:12.003 に答える
3

リモートWebサービスにアクセスしている場合は、対応するWSDLにアクセスできると思います。それを解析して必要な情報だけを探すのはどうでしょうか。または、これを行うためのツールを使用していますか（「wsdlドキュメントジェネレーター」をグーグルで検索しました）？または、WSDL.exeを使用してWSDLからダミーコードを生成し、それを文書化することもできます。おそらくGhostDocの助けを借りますか？HTH

于 2009-01-14T22:13:22.123 に答える
2

リフレクションを使用してメソッドなどをダンプできますか?

リフレクションは .Net の機能で、実行時にオブジェクトに関する情報を取得できます。その情報には、クラスのデータが含まれています。また、そのオブジェクトのクラスとコンストラクター内にあるメソッドの名前を取得できます。

于 2009-01-14T21:45:34.880 に答える
1

VS.net はインテリセンスのドキュメントを生成すると思います。既存のアセンブリの場合、ファイル システムに既に存在します (例: C:\Windows\Microsoft.NET\Framework\v2.0.50727\en)。

VS.NET でベンダーのアセンブリを使用してみてください。sysinternals のプロセス エクスプローラーなどのツールを使用して、読み込まれているファイルを確認します。カスタム アセンブリ用に作成された xml ファイルがあることがわかると思います (これは、Intellisense とそれで利用可能なドキュメントを表示するために使用されます)。

それが役立つことを願っています。

編集:同じフォルダー (カスタム アセンブリが配置されている場所) に、ドキュメント用の xml ファイルがあると思います。

于 2009-01-14T22:01:45.643 に答える
0

API ドキュメントを再現する代わりに、リフレクター (redgate から)を使用してアセンブリ (逆コンパイル) を表示できますか。リフレクターで実際に表示されないドキュメントをリフレクトしてビルドすることで他に何が得られるかはわかりません（もちろん、これは読み取り可能なコードの記述に依存します.

于 2009-01-14T21:58:08.630 に答える
0

おかしな話かもしれませんが、リスト全体のスクリーンショットを撮って、OCR プログラムで実行していただけませんか?

于 2009-01-14T21:58:48.940 に答える
0

dll がある場合、それらを逆コンパイルしてから再コンパイルして nDoc を使用できませんか? それはあなたに合理的なスタートを与えるはずです。

于 2009-01-14T21:47:24.237 に答える