文檔 ASMX 網絡服務

Question

我正在開發一個 web 服務來發布供不同用戶使用。

為了使他們的工作順利進行，我想記錄我所有的 web 方法及其輸入/輸出對象，如下圖所示（這是我在網上看到的示例）。

我只是嘗試使用 WebMethodAttribute 來裝飾我的方法，但我唯一實現的就是方法描述。

我嘗試使用 WCFExtras 但不適合我的項目，因為它不是 WCF 服務：/

我問：有沒有什么工具可以做這種工作？ 有誰知道要使用的任何 .NET 屬性或框架？

Answer 1

我對Sandcastle和標准C# XML 文檔的組合感到滿意。

基本上，您可以像往常一樣對方法進行注釋（在類型或方法名稱之前鍵入///以生成注釋框架）。 然后，在項目上啟用 XML 文檔 output 。 最后，您使用工具（例如 Sandcastle）使用生成的 XML 文件來構建幫助文件/網站。

在 Sandcastle 的案例中，它會生成一個 CHM。 我個人喜歡將 API 視為 CHM 文件。 還有其他工具可以使它成為 Web 站點。