Документация веб-службы .asmx

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, на самом деле не существует автоматического способа использования комментариев метода 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>

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

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