All geek questions in one place

Can I provide summary information or similar information to get Intellisense on the consumed WCF service?

I have a WCF service where the methods are the same as the following. Now I know that <summary> not displayed, but how can I get this information so that the consumer receives information in intellisense?

 /// <summary> /// Obtains a list of agreements for a given dealer /// </summary> /// <param name="query">Object identifying the dealer<see cref="AgreementListRequest"/></param> /// <returns>Object containing a list of all agreements for the provided dealer<see cref="AgreementListResponse"/></returns> [OperationContract] [FaultContract(typeof(DatabaseFault))] [FaultContract(typeof(ServiceAgentFault))] AgreementListResponse GetAgreements(AgreementListRequest request);
+4
source share
1 answer

These code comments exist only on the server - these are comments, and they are specific to .NET, so they will not be transported through the wire when creating a proxy server on the client side for your WCF service.

There is only one way that I can see so that you can get what you want: if you control both ends of the wire, for example. you write both the service (server) and the client side, you can put your service contracts and data in a separate assembly of Contracts , and then share this assembly between the service and the client-side code. In this case, your client-side code will use the same file and therefore will have access to the code comments and they will be displayed in intellisense

The second option I just came across is WCFExtras is a Codeplex project that has some extensions for WCF. One that may interest you is an extension that makes your server side XML code comments in xsd:documentation tags in WSDL and back to client side XML code comments (when using the .NET client).

Adding WSDL documentation from XML source code comments
This extension allows you to add WSDL documentation (annotaiton) directly from XML comments in the source file. These comments will be published as part of WSDL and are available for WSDL Tools that know how to take their benefits (e.g. Apache Axis wsdl2java and others). Version 2.0 also includes a client-side WSDL importer, which will turn these WSDL comments on XML comments into generated proxy code.

+5
source

Source: https://habr.com/ru/post/1338382/

More articles:


All Articles