Visual Studio XML комментарии (резюме) и специальные символы - PullRequest
12 голосов
/ 20 апреля 2010

У меня есть метод в проекте C # / Wpf, и я хотел бы комментировать / документировать его, используя XML-комментарии, подобные этому

    /// <summary>
    /// Initialises Drag & Drop
    /// </summary>
    void initDragDrop()
    {

    }

Когда я сейчас использую этот метод где-то в своем проекте и наведя на него курсор мыши, я получаю сообщение «XML-комментарий содержит недопустимый XML: в этом месте пробелы запрещены» (я перевел текст после двоеточия вручную на английский, поэтому он может быть не буквально в вашей визуальной студии). Я обнаружил, что проблема в знаке "&", если я его уберу, он работает нормально. Но я хочу сохранить это, так как мне избежать этого в сводке XML? Я пытался "\ &", но это не работает.

Спасибо за любую подсказку!

1 Ответ

18 голосов
/ 20 апреля 2010

Помните, что символ & имеет особое значение в xml (начало сущности). Вам нужно написать свой комментарий, как это (раздражает, я знаю):

/// <summary>
/// Initialises Drag &amp; Drop
/// </summary>
void initDragDrop()
{

}

Я могу ошибаться в этом следующем пункте, но я не думаю, что вы можете даже использовать раздел CDATA, чтобы избежать сущности, потому что это нарушает комментарии. Вы должны набрать всю &amp; сущность.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...