Описание тега xml-comments

Comments for program code that are written in XML.
0 ответов

Раскомментирование в XML-файле с помощью Powershell

Я пишу сценарий, который заменяет и удаляет некоторые закомментированные строки, но проблема в том, что файл.xml получил более одного комментария, и мне нужно только раскомментировать один из них. Было бы не проблема, если бы все было написано в одн…
23 ноя '17 в 11:17
1 ответ

Ссылка на тип, на который не ссылается мой проект в комментариях XML?

Я сталкивался с этой ситуацией несколько раз раньше. Я хочу сослаться на тип в моих комментариях XML, но этот тип содержится в сборке, на которую не ссылается мой проект. В A.Dll (ссылки B.DLL): using B; ///<summary>Hai I'm SomeClass and I use…
09 дек '08 в 16:39
1 ответ

Альтернатива XML-комментариям к документации в C#

Когда вы спрашиваете об условных комментариях к документации в коде C#, ответ всегда приводит к использованию XML-комментариев. Microsoft рекомендует такой подход и самим. https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recom…
02 фев '19 в 20:49
3 ответа

Комментарии XML - Документация MSDN Раздел "Примечание" - как вы продублируете это?

По сути, в онлайн-справке MSDN я часто сталкиваюсь с разделом "ПРИМЕЧАНИЕ", но никак не могу понять, как получить такой же вывод. Видимо нет <note> тег. Кто-нибудь знает, как заставить это работать? IDictionary (TKey, TValue) - в этом примере,…
12 сен '11 в 20:28
0 ответов

"-" не допускается в комментариях: почему возникает эта ошибка

Я использовал 1 комментарий в документе XML. Это работает нормально в моей системе. Но когда я развернул свое программное обеспечение на сервере, он выдает ошибку в этой строке. "-" не допускается в комментариях. Как решить эту проблему? Пожалуйста,…
28 июн '12 в 05:42
1 ответ

Можно ли дать частям параметра Func<T1, T2,....> xml комментарии для intellisense?

Итак, у меня есть действие, которое принимает обратный вызов и выполняет его. Это выглядит немного так. Могу ли я что-нибудь заполнить в области вопросительного знака (или в другом месте), чтобы документировать детали аргументов, входящих в параметр…
17 мар '16 в 15:44
1 ответ

Как добавить комментарии XML к автоматически сгенерированным классам, созданным Entity Framework при использовании подхода Model-First?

Я добавил информацию в свойство Documentation.Summary в графическом редакторе, но она не добавляется в сгенерированные классы. Есть какой-либо способ сделать это?
03 янв '13 в 16:20
1 ответ

Каковы поддерживаемые символьные объекты для комментариев XML?

В следующем примере &amp;amp; а также &amp;#916; все в порядке, но &amp;Delta; нет (последние два оба Δ). Компилятор выдает предупреждение, похожее на: предупреждение CS1570: XML -комментарий к "XXX.DocumentedMethod()" имеет неправильно сформированн…
02 окт '09 в 20:06
1 ответ

Как я могу объединить комментарии XML обратно в файл.cs?

Извлечение комментариев из файлов класса C# относительно легко (см. Извлечение комментариев из документа из исходного файла C#), но недавно я столкнулся с противоположной проблемой. Мой проект имеет несколько классов, которые генерируются из схемы X…
20 ноя '14 в 21:13
3 ответа

XML многострочные комментарии в C# - что я делаю не так?

Согласно этой статье, можно получить многострочные комментарии XML - вместо использования ///использовать /** */, Это моя интерпретация многострочных комментариев и того, что я хочу, чтобы это произошло: /** * &lt;summary&gt; * this comment is on li…
1 ответ

<see cref> XML-комментарий для байта [] без ошибок

Я пытаюсь написать &lt;see cref&gt; XML-комментарий для типа byte[], К сожалению, стандартный синтаксис: &lt;see cref="T:System.Byte[]"&gt; вызывает ошибку при выполнении команды " Удалить и отсортировать с помощью VS", как описано здесь: https://co…
27 май '15 в 23:15
2 ответа

Получение Intellisense для интерфейса, который реализует метод, если у этого метода нет собственных комментариев XML

В Visual Studio 2010 есть способ получить Intellisense для интерфейса, который реализует метод, если у этого метода нет собственных комментариев XML? Я полагаю, что-то вроде этого было бы довольно полезно. Мне нравится включать XML-комментарии в инт…
2 ответа

Добавление XML-комментариев к свойствам класса, созданным конструктором LINQ to SQL

Я использовал конструктор LINQ to SQL в Visual Studio для создания объектной модели базы данных. Теперь я хочу добавить комментарии XML к каждому сгенерированному свойству, но я не могу понять, как это сделать, не стирая свойства при следующем обнов…
01 сен '08 в 06:15
2 ответа

Чтение комментариев XML

Я пытаюсь использовать XML-файл планировщика задач Windows. Для тех, кто не знает, XML-файл выглядит так: &lt;?xml version="1.0" encoding="UTF-16"?&gt; &lt;Tasks&gt; &lt;!-- \job1 --&gt; &lt;Task version="1.2" xmlns="http://schemas.microsoft.com/win…
12 авг '13 в 12:00
3 ответа

По какому соглашению разработчики C# указывают свое авторство класса?

Я прочитал из нескольких мест и узнал, что в комментариях C# XML нет автора. Но я уверен, что часто встречаются ситуации, когда мы должны использовать некоторые способы, чтобы сказать людям, что тот или иной класс написан кем и кем. Для себя я работ…
01 ноя '12 в 23:13
2 ответа

Вывод XML-комментариев веб-сайта ASP.NET

Я хотел бы документировать исходный код моего веб-сайта VB.NET. Как преобразовать комментарии XML на веб-сайте VB.NET ASP.NET в файл документации XML? Я не вижу возможности для создания файла документации XML на страницах свойств веб-сайта VS.
24 фев '14 в 07:19
1 ответ

Как мне избежать ключевых слов в комментариях XML, таких как "примечание"?

Как мне избежать ключевых слов в комментариях XML, таких как "примечание" в Visual Studio? например /// See note re Create method attached to this type. Я не хочу, чтобы текст после слова "заметка" становился синим. Обратите внимание, что это может …
01 фев '10 в 22:53
3 ответа

pyparsing - разобрать xml комментарий

Мне нужно проанализировать файл, содержащий комментарии XML. В частности, это AC# файл с использованием MS /// условность. Из этого мне нужно вытащить foobar, или же /// foobar было бы приемлемо тоже. (Обратите внимание - это все равно не работает, …
19 окт '11 в 16:54
1 ответ

Почему XMLStreamReader/StAXSource удаляет комментарии из XML?

Код ниже (на основе примера кода с http://jax-ws.java.net/nonav/jax-ws-20-fcs/arch/com/sun/xml/ws/util/xml/StAXSource.html) String xml = "&lt;a&gt;&lt;b&gt;a text&lt;/b&gt;&lt;!--a comment--&gt;&lt;b/&gt;&lt;/a&gt;"; StringReader sr = new StringRead…
03 апр '13 в 15:48
0 ответов

Отображение общих параметров комментариев XML в Intellisence для статического метода

У меня возникают проблемы при получении общих параметров для двух методов ниже для отображения типов в Intellisence. Для IEnumerable&lt;T&gt; Я просто хочу, чтобы это показывалось как double, И для IDictionary&lt;TKey,TValue&gt; перегруз, хочу это п…
01 май '14 в 15:36