Web サービス ( .asmx) を介して API を公開しています。現在、利用できるのはデフォルトの WSDL ヘルプ ページだけです。これは非常に役に立ちますが、対象となる視聴者がもう少し手を握る必要がある場合は十分ではありません. たとえば、いくつかの例を含めたいが、メソッド シグネチャなどの自動生成が必要だとします。
これを達成するための半自動化された（自動メソッド署名ですが、例を提供できる）ものはありますか？このような保守可能なものを探しています。理想的には、デフォルトの WSDL を変更するのに役立つもの (私はそのページがとても気に入っています) があれば素晴らしいと思います。必要なのは、サービスが展開されたときにドキュメントがサービスと共に自動的に利用可能になることだけです。
助言がありますか？
おそらく最も簡単な方法は、XMLドキュメントのコメントを使用することです。
これらのコメントを使用すると、HTMLドキュメントを自動的に生成できます。たとえば、SandcastleまたはNDoc3を使用します。
VisualStudioプロジェクトをビルドするときにSandcastleドキュメントをビルドする
そして結局のところ、HTMLドキュメントをサービスの近くの共有場所に自動的に保存することができ、ブラウザを使用してそこに簡単に移動できます。したがって、すべてが近くにある可能性があります-wsdl+htmlドキュメント
他のポスターに同意しますが、私は NDoc3 を使用して多くの成功を収めました。Sandcastle よりもかなり高速です (これも非常に優れたツールです)。NDoc3 は、.chm、.doc、および .html 出力を作成します。
NDoc3 と Sandcastle はどちらも MSDN スタイルのドキュメントを生成します。