Есть ли хороший способ для отображения длинных комментариев XML в Visual Studio без перехода к определению?

Question

Всплывающие подсказки, которые показывают комментарии, удобны, но для длинных комментариев всплывающая подсказка становится бесполезной, потому что она длится всего несколько секунд, а комментарий растягивается вдоль одной строки, пока не закончится.

Можно перейти к комментариям, перейдя к определению, но это раздражает, поскольку открывает вкладки для исходных файлов, над которыми я не работаю, и портит историю переходов вперед / назад. Он также страдает от проблемы, с которой вы обращаетесь к XML (который должен быть экранированный ) вместо красиво отформатированной документации.

Что я действительно хотел бы увидеть, так это то, как Eclipse отображает комментарии Javadoc. В этом сообщении в блоге показано сравнение всплывающих подсказок схожих классов в Visual Studio и Eclipse.

Существует ли такой режим или плагин для Visual Studio?

Answer 1

Вы можете поместить свои xml-комментарии в несколько строк с помощью тега <para>. Таким образом, ваши длинные комментарии не будут выходить за пределы экрана:

/// <summary>
/// <para>First line of your comment</para>
/// <para>Second line of your comment</para>
/// </summary>

О задержке для этих подсказок; это был длительный запрос для Visual Studio, который до сих пор не исправлен. Последний раз запрашивал здесь , и даже в 2004 году здесь .

Answer 2

Я использую GhostDoc для автоматической генерации комментариев XML для моего кода, это особенно полезно, поскольку вы не тратите слишком много времени на повторную генерацию комментариев, и это помогает сделать информацию об API согласованной.

Пара идей:

Вы можете использовать гиперссылку в комментарии, как показано ниже.Это может указывать на справочную систему:

Вы можете использовать это вместе с SandCastle , вот отличная статья Создание документации длясетевой компонент с помощью построителя файлов справки Sandcastle :

Создание файла XML из комментариев по умолчанию отключено.Его следует включить в свойствах проекта на вкладке «Сборка».

В результате файл XML будет создаваться при каждой сборке вашего исполняемого файла илисборка.Этот файл будет содержать все комментарии XML из кода, включая комментарии для всех непубличных сущностей.Этот файл сам по себе полезен, поскольку, когда вы помещаете его рядом со сборкой, функция IntelliSense в Visual Studio будет использовать информацию из этого файла для отображения описаний методов, свойств и параметров сборки.Вот пример того, как будет выглядеть функция GetR, показанная выше: