Вопросы по теме 'xml-comments'

Поиск отсутствующего содержимого комментариев XML с помощью Visual Studio
Во всем исходном коде C # у нас есть много комментариев, в которых отсутствует фактическое содержание, например: /// <summary> /// </summary> или это: /// <summary> /// /// </summary> или это: ///...
3245 просмотров
schedule 28.01.2023

Как я могу автоматически экспортировать исходные комментарии XML в текстовый документ?
Я использую XML-комментарии для документирования исходного кода в VB.Net (и C#, когда доберусь). Кажется, я помню, как давным-давно кто-то сказал мне, что есть способ автоматически экспортировать XML-комментарии в текстовый документ или другой формат...
3051 просмотров
schedule 20.08.2022

XML-комментарии ‹список› не отображаются в IntelliSense
Я пытаюсь заставить комментарии VB.NET XML работать с IntelliSense , и, возможно, это не так. работать так, как я думаю. ''' <summary> ''' Gets or sets the Patient Code. ''' <list type="bullet"> '''...
3674 просмотров

Может ли ConfigurationManager сохранять XML-комментарии к Save()?
Я написал небольшую утилиту, которая позволяет мне изменить простой AppSetting для файла App.config другого приложения, а затем сохранить изменения: //save a backup copy first. var cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile);...
4302 просмотров

Заставить Visual C ++ генерировать XML-комментарии только для моих файлов?
возникла проблема, на которую я не могу найти прямого ответа. Я нахожусь на поздних этапах создания игрового движка с несколькими друзьями, и на данный момент мы стремимся упростить комментарии, чтобы сделать их более удобочитаемыми и полезными для...
556 просмотров
schedule 07.03.2022

Документирование массива типа T в формате vsdoc для javascript, Нашел ли я ошибку?
Следуя этим рекомендациям для vsdoc документации , мне не удалось заставить intellisense правильно работать с массивом заданного типа. Вот некоторый код, который демонстрирует проблему function MyType() { /// <summary>Class...
890 просмотров

Остановить VB от показа предварительного просмотра комментариев xml
Когда вы создаете XML-комментарий в C# и сворачиваете его, вы видите только: <Summary>... Но в VB вы могли бы увидеть Initializes the fubble to the watzer. This is actually the second line. Наличие этой строки над вашим кодом...
140 просмотров

Как указать язык в теге ‹code› комментария xml
Есть ли способ указать, какой язык используется в теге <code> , используемом в теге <example> в комментариях XML? Я использую Sandcastle Help File Builder для тестирования документации по созданию документации из моих...
3153 просмотров
schedule 12.03.2023

Visual Studio 2010 SDK Как поместить украшение рядом с группами комментариев XML?
У меня возникли проблемы с поиском, как это сделать, и справочник Visual Studio SDK также не очень полезен. Я пытаюсь понять, как получить NormalizedSnapshotSpanCollection комментариев XML. Я хочу разместить значок рядом с ними... Я не хочу...
1631 просмотров

Как сделать выделенный текст тройной косой чертой в Visual Studio 2010
В Visual Studio 2010 мы можем Comment выделенный текст через Ctrl+E,C — это ставит перед выбранными строками двойную косую черту. Есть ли способ выделить текст и добавить в VS2010 к выбранным строкам тройную косую черту? Для любопытных; Я...
744 просмотров
schedule 19.01.2023

Комментарии Javascript Visual Studio 2010 перестали работать
Когда я набираю ///, Visual Studio больше не добавляет комментарии xml в мой документ javascript. Недавно я установил несколько расширений и задался вопросом, не могли ли они вызвать это, срок действия одного из которых недавно истек (повторно...
282 просмотров

Почему XML-генератор документации C# работает некорректно для COM-импортированных интерфейсов?
При использовании комментариев XML-документации в C# для создания XML-файла документации в VS2010 SP1 я заметил, что он не работает должным образом в одном конкретном случае : для членов интерфейса, импортированных из COM . > (методы и свойства)....
482 просмотров

Помещение комментариев в XML, который присутствует в моих блоках комментариев C # XML
Я использую блок примера кода в комментарии XML как простой способ дать пользователю представление о том, как выглядит XML. Это очень приблизительное решение, и в конечном итоге пользователю будет предоставлена ​​XML-схема для строки xml. Однако...
1197 просмотров

Пользовательская схема для комментариев XML в Visual Studio для C#
Когда я набираю «///» в редакторе, Visual Studio создает пустой текст комментария с ‹ сводкой > и другими тегами. Затем я могу ввести «‹», и VS предложит список рекомендуемые теги . Как я могу заставить IntelliSense предлагать мои...
1668 просмотров
schedule 25.02.2022

Вывод XML-комментариев веб-сайта ASP.NET
Я хотел бы задокументировать исходный код моего веб-сайта VB.NET. Как преобразовать комментарии XML на веб-сайте VB.NET ASP.NET в файл документации XML? Я не вижу возможности создать файл документации XML на страницах свойств веб-сайта VS.
652 просмотров

XML-сообщение для возвращаемой коллекции типа T
Я хотел бы указать в комментариях XML, что метод возвращает коллекцию IEnumerable<FileInfo> . Какой правильный формат для XML-тега <returns/> . /// <summary> /// Extensions methods for class <see...
26 просмотров
schedule 08.09.2022

Как я могу объединить XML-комментарии обратно в файл .cs?
Извлечь комментарии из файлов классов C# относительно просто (см. Исходный файл C# ), но недавно я столкнулся с противоположной проблемой. В моем проекте есть куча классов, которые генерируются из схемы XML (через Microsoft xsd.exe ). Я хотел бы...
203 просмотров
schedule 09.04.2023

Как отобразить содержимое включенного документа Xml во всплывающих подсказках Intellisense с помощью тега ‹include›
Я пытаюсь навести порядок в своих классах, содержащих достаточное количество кода. Я также хочу документировать и документировать хорошо. К сожалению лично для меня делать все это в одном файле создает хаос для глаз. Это грубо и для быстрой...
419 просмотров

C#: Написание сводки для свойств с разными методами доступа для геттера и сеттера
Я очень дисциплинирован в написании подробных описаний интерфейсов, классов, свойств и методов. Пока я сосредоточен на том, чтобы поделиться своим кодом со всеми, кто может читать без каких-либо затрат на ненужные объяснения. Я следую личному...
474 просмотров
schedule 27.05.2022

Автоматическое комментирование XML C# в коде Visual Studio
В MonoDevelop, когда я набираю «///», он автоматически генерирует комментарий в стиле xml, например: /// <summary> /// Describes the variable x /// </summary> int x = 0; Есть ли способ получить это поведение в коде Visual Studio?
20912 просмотров
schedule 21.07.2022