.asmx Web服务文档

Question

我希望我的摘要，参数信息，返回信息等（如下所示）显示在.net为.asmx网络服务生成的标准帮助页面上。

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

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

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

我确定我错过了一些非常简单的东西（或者不可能做我想做的事）。有什么建议吗？

Answer 1

与@John Saunders一样，评论提到在WSDL帮助中没有使用XML方法注释的自动方式，但有几种方法可以获得你想要的东西。

可以将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