.asmx Web服务文档

Question

我希望我的摘要、参数信息、返回信息等（如下所示）能够显示在 .asmx Web 服务生成的标准帮助页面上。

/// <summary>
/// Brief description
/// </summary>
/// <param name="fakeParamOne">Fake Param One Description</param>
/// <returns>Bool representing foo</returns>

我尝试过的唯一能影响自动生成的帮助页面的方法是这个:

[WebMethod(Description = "Does awesome things.")]

我相信我错过了非常简单的东西（或者想要做的事情是不可能的）。有什么建议吗？

- James Hill

---

没有自动完成你所要求的操作的方法。实际上，在WCF中，帮助页面已经被废弃了，因为它的实用性非常有限。 - John Saunders

“WCF中的帮助页面已经被废弃，因为它的实用性非常有限”？真的假的？ - Jenda

Answer 1

正如@John Saunders评论所提到的，没有一种自动的方法可以使用XML方法注释在WSDL帮助中显示，但有几种替代方案可以达到您想要的效果。

WebMethod描述属性可以设置为格式化HTML

这里是一个例子：

const string someWebMethodDescription = @"
<table>
    <tr>
        <td>Summary:</td><td>[My Summary]</td>
    </tr>
    <tr>
        <td>Parameters:</td><td>&nbsp;</td>
    </tr>
    <tr>
        <td>fakeParam:</td><td>[My Fake Param Description]</td>
    </tr>
</table>";

[WebMethod(Description=someWebMethodDescription)]
public List<string> SomeWebMethod

结果如下所示：

或者，创建自定义WSDL帮助页面

<configuration>
   <system.web>
      <webServices>
         <wsdlHelpGenerator href="docs/HelpPage.aspx"/>
      </webServices>
   </system.web>
</configuration>

请查看这篇CodeProject文章，了解如何制作自己的HelpPage：

Improving the ASP.NET Webservice Help Generator to Reflect Inheritance - CodeProject

- MikeM