.asmx Документация по веб-сервису

Мне бы хотелось, чтобы мое резюме, информация о параметрах, информация и т.д. (перечисленные ниже) отображались на стандартной странице справки, которая .net генерирует веб-службы .asmx.

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

Единственное, что я попытался повлиять на страницу сгенерированной автоматической сгенерировкой, это:

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

Я уверен, что мне не хватает чего-то ОЧЕНЬ простого (или это невозможно сделать, что я хочу). Любые предложения?

Ответы

Ответ 1

Как и комментарий к комментарию @John Saunders, на самом деле нет автоматического способа использования комментариев метода XML для отображения в Справке WSDL, но есть несколько альтернатив для получения того, что вы ищете.

Атрибут 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

Где результат:

Web Method with Custom HTML Description

Кроме того, для создания пользовательской страницы справки WSDL

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

проверьте эту запись в кодебере для получения дополнительной информации о создании собственной справки:

Улучшение генератора справки ASP.NET Webservice для отражения наследования - CodeProject