asp.net - .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 评论中提到的那样，实际上并没有一种自动方法可以使用 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>

查看此代码项目帖子，了解有关制作自己的帮助页面的详细信息:

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