Можно ли предоставить сводную информацию или аналогичную информацию для получения Intellisense для потребляемой службы WCF? - PullRequest
Новая
       1

Можно ли предоставить сводную информацию или аналогичную информацию для получения Intellisense для потребляемой службы WCF?

5 голосов
/ 04 февраля 2011

У меня есть служба WCF, где много методов, как показано ниже.Теперь я знаю, что информация <summary> не раскрывается, но как я могу раскрыть эту информацию, чтобы потребитель получил информацию в 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);

1 Ответ

5 голосов
/ 04 февраля 2011

Эти комментарии к коду существуют только на сервере - они являются комментариями и являются специфичными для .NET, поэтому они не будут передаваться по проводам при создании прокси на стороне клиента для службы WCF.

Я вижу только один способ получить то, что вы хотите: если вы контролируете оба конца провода, например, вы пишете как службу (сервер), так и сторону клиента, вы можете поместить свои контракты на обслуживание и данные в отдельный Contracts сборка, а затем поделиться этой сборкой между службой и кодом на стороне клиента.В этом случае ваш клиентский код будет использовать точно такой же файл и, следовательно, будет иметь доступ к комментариям кода, и они будут отображаться в intellisense

Второй вариант, на который я только что наткнулся, - WCFExtras - проект Codeplex, который имеет некоторые расширения для WCF.Вас может заинтересовать расширение, которое отображает ваши комментарии XML-кода на стороне сервера в теги xsd:documentation в WSDL и обратно в комментарии XML-кода на стороне клиента (при использовании клиента .NET).

Добавление документации WSDL из исходного кода Комментарии XML
Это расширение позволяет добавлять документацию WSDL (annotaiton) непосредственно из комментариев XML в исходный файл.Эти комментарии будут опубликованы как часть WSDL и доступны для инструментов WSDL, которые знают, как ими воспользоваться (например, Apache Axis wsdl2java и другие).Версия 2.0 также включает в себя импортер WSDL на стороне клиента, который преобразует эти комментарии WSDL в комментарии XML в сгенерированном коде прокси.

...