Комментарии XML для раздела «Описание» свойств в сервисном сообщении Документация по контракту с использованием Sandcastle - PullRequest
Новая
       40

Комментарии XML для раздела «Описание» свойств в сервисном сообщении Документация по контракту с использованием Sandcastle

0 голосов
/ 07 марта 2012

Я пытаюсь сгенерировать документацию для веб-службы в C # с использованием Sandcastle.

Я бы хотел добавить описание к свойствам запроса MessageContract: Description Section

Вот фрагмент кода, который у меня сейчас есть: 

namespace RWS.MessageContracts
{
/// <summary>
/// Service Contract Class - GetCoverageDataDisclosuresRisksRequest
/// </summary>
/// <remarks>Request for the GetCoverageDataDisclosuresRisks method.</remarks>
[WCF::MessageContract(WrapperName = "GetCoverageDataDisclosuresRisksRequest", WrapperNamespace = "http://researchwebservice.model/research")] 
public partial class GetCoverageDataDisclosuresRisksRequest
{
    private RWS.DataContracts.UniqueIDCollection audienceTypeIdentifier;
    private RWS.DataContracts.ExchangeTicker exchangeTickers;
    private RWS.DataContracts.IntegerCollection organizations;
    private RWS.DataContracts.IntegerCollection companies;

    /// <remarks>Unique Identifier of an AudienceType <seealso cref="RWS.DataContracts.UniqueIDCollection"/></remarks>
    [WCF::MessageBodyMember(Namespace = "http://researchwebservice.model/research", Name = "AudienceTypeIdentifier")]
    public RWS.DataContracts.UniqueIDCollection AudienceTypeIdentifier
    {
        get { return audienceTypeIdentifier; }
        set { audienceTypeIdentifier = value; }
    }

Как мне прокомментировать этот код, чтобы получить замечания, которые у меня сейчас есть («Уникальный идентификатор типа Audience») для отображения в этом разделе?

1 Ответ

1 голос
/ 07 марта 2012

Описания основаны на тегах <summary>. Я думаю, вы должны просто изменить теги <remarks> на <summary>. Раздел примечаний отображается только на странице объекта и должен содержать дополнительную подробную информацию об объекте.

...