.asmx Web Service Documentation

Question

Chciałbym, aby moje podsumowanie, informacje o paramecie, zwróciło informacje, itp. (Wymienione poniżej), aby pokazać się na standardowej stronie pomocy, którą .NET generuje dla serwisów internetowych .asmx.

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

Jedyne co próbowałem które wpłynęły na stronę pomocy automatycznie wygenerowane w jakikolwiek sposób było to:

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

jestem pewien, że jestem brakuje czegoś bardzo prostego (lub jego nie mogę robić tego, co chcę). Jakieś sugestie?

Answer 1

Jak wspomniano w komentarzu do @ Soulersa, nie ma automatycznego sposobu użycia komentarzy metody XML do wyświetlenia w Pomocy WSDL, ale istnieje kilka alternatyw, aby uzyskać to, czego szukasz.

WebMethod Opis atrybutu może być ustawiona na być sformatowany HTML

Oto przykład:

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 

Jeżeli wynik jest:

Alternatywnie, w celu stworzenia niestandardową stronę pomocy WSDL

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

check to CodeProject po szczegółowe informacje na temat tworzenia własnego Helppage:

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