.asmx Web Service Documentation

Question

. Netx web hizmetleri için oluşturduğu standart yardım sayfasında görünmesi için özetimi, param bilgisini, bilgi döndürmeyi, vb. (Aşağıda listelenir) istiyorum. Ben herhangi bir şekilde otomatik olarak oluşturulan yardım sayfasını etkilediğini denedim

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

tek şey şuydu:

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

ben ÇOK basit bir şey eksik eminim (veya öyle istediğimi yapmak mümkün değil). Baska öneri?

Answer 1

@John Saunders adlı yorumda, WSDL Yardımı'nda görünmesi için XML yöntem yorumlarının kullanılmasının otomatik bir yolu olmadığı belirtiliyor, ancak aradığınız şeyi elde etmek için birkaç alternatif var.

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 

sonucudur:

Alternatif

oluşturmak için

WebMethod Açıklama özelliğinin İşte

HTML biçimlendirilmiş olması için ayarlanabilir

bir örnek özel bir WSDL Yardım Sayfası

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

çek kendi helppage yapmaya ilişkin ayrıntılar için bu codeproject mesaj:

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