我希望我的摘要、参数信息、返回信息等(如下所列)显示在.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.")]
我确信我错过了一些非常简单的东西(或者它不可能做我想做的事情)。有什么建议吗?
发布于 2011-06-18 04:09:51
就像@John Saunders评论提到的那样,没有一种自动的方式来使用XML方法注释来显示在WSDL帮助中,但有几种替代方法可以获得您正在寻找的内容。
可以将WebMethod描述属性设置为带格式的HTML
下面是一个例子:
const string someWebMethodDescription = @"
<table>
<tr>
<td>Summary:</td><td>[My Summary]</td>
</tr>
<tr>
<td>Parameters:</td><td> </td>
</tr>
<tr>
<td>fakeParam:</td><td>[My Fake Param Description]</td>
</tr>
</table>";
[WebMethod(Description=someWebMethodDescription)]
public List<string> SomeWebMethod
其中,结果是:
或者,创建自定义帮助页
<configuration>
<system.web>
<webServices>
<wsdlHelpGenerator href="docs/HelpPage.aspx"/>
</webServices>
</system.web>
</configuration>
有关制作自己的HelpPage的详细信息,请查看此代码项目帖子:
Improving the ASP.NET Webservice Help Generator to Reflect Inheritance - CodeProject
https://stackoverflow.com/questions/6390806
复制相似问题