.asmx Web服务文档

Question

我希望我的摘要,参数信息,返回信息等(下面列出)显示在.net为.asmx Web服务生成的标准帮助页面上.

/// <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 Description属性可以设置为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>

有关制作自己的HelpPage的详细信息,请查看此codeproject帖子:

改进ASP.NET Web服务帮助生成器以反映继承 - CodeProject