9
голосов
1ответов
915 просмотров

What are the supported character entities for XML comments?

In the following example, & and Δ are OK but Δ is not (the latter two are both Δ). The compiler issues a warning similar to: warning CS1570: XML comment on 'XXX.DocumentedMethod()' has badly formed XML -- 'Reference to undefined entity 'Delta'.' /// <summary&...

0
голосов
2ответов
1271 просмотров

How to autocorrect xml documentation of methods

In the below code in xml documentations there is mismatch between the names of parameters in method's arguments and name of parameters in xml documentation. Is there any way to auto correct the xml documentation signature or any feature provided in resharper to auto correct the xml documentation....

11
голосов
2ответов
3433 просмотров

XML Comments <list> not displaying in IntelliSense</list>

I am trying to get VB.NET XML Comments to work with IntelliSense, and maybe it doesn't work the way I think it does. ''' &lt;summary&gt; ''' Gets or sets the Patient Code. ''' &lt;list type="bullet"&gt; ''' &lt;listheader&gt;&lt;description&gt;Validation:&lt;/description&gt;&lt;/...

5
голосов
3ответов
3386 просмотров

howto collapse all XML comments in Visiual Studio 2008

i was wondering if there is an plugin, addon or any other easy way to get rid of the bloated xml comments for c#? Company wants the documentation, but in my daily work the comments are simply polluting the code. It would be nice to have an easy way to simply collapse all xml documentation before...

3
голосов
1ответов
2923 просмотров

How can I automatically export XML source comments to a text document?

I have been using XML comments to document my source code in VB.Net (and C# when I get to). I seem to remember someone telling me a long time ago that there was a way to automatically export the XML comments into a text document or other format for easy reference outside of Visual Studio. Is ther...

4
голосов
1ответов
581 просмотров

How can the .NET source code XML comments be persisted in the assembly metadata?

Have you noticed that for some methods in the system assemblies, the .NET Reflector also shows the respective documentation? Which means that the documentation can be persisted in the assembly metadata. How can I make it work for my own assemblies? Meaning, I want to see my comments to my method...

4
голосов
4ответов
2084 просмотров

Возможно ли в Visual Studio 2008 автоматически создавать теги комментариев XML без установленного флажка «Создать файл документации XML» (только для VB.NET)?

В VS 2008, если разработчик нажимает "" ", он генерирует теги комментариев XML для вас, но это работает только тогда, когда установлен флажок проекта" Создать файл документации XML ". Есть ли способ указать VS создать теги комментариев XML независимо от настроек проекта? Я думаю, что ком...

4
голосов
2ответов
1648 просмотров

Комментарии XML в Resources.Designer.cs?

В моем проекте Visual Studio 2008 у меня есть этот проект с Resources.resx, который содержит изображения и строки. Чтобы заставить себя и всех остальных написать хотя бы XML-комментарии, я включил генерацию XML-комментариев на вкладке сборки свойства проекта. Теперь Visual Studio выдает мне не...

6
голосов
2ответов
1232 просмотров

Можно ли викифицировать XML-комментарии Visual Studio?

Можно ли создать набор вики-страниц из файла комментариев XML, созданного Visual Studio? Я говорю о чем-то вроде Sandcastle, но для формата wiki вместо скомпилированного CHM. Изменить: я использую MediaWiki, который может импортировать / экспортировать статьи в XML. Так что я надеюсь, что ...

3
голосов
2ответов
839 просмотров

Как увидеть XML-комментарии кода из Reflector

Я предпочитаю просматривать сборки с помощью отражателя, даже если у меня есть исходный код, особенно на тот случай, когда я перехожу в новый проект. Но мне кажется, было бы неплохо, если бы я мог видеть XML-комментарии исходного кода в отражателе. Есть ли надстройка, которая бы это сделала? ...

7
голосов
1ответов
504 просмотров

Ссылка на общий комментарий

Мне было интересно, можно ли указать имя динамического универсального класса в комментарии и разрешить его условно в среде IDE? Пример простого базового класса: // &lt;summary&gt; // Retrieves all &lt;T&gt; members from the database. // &lt;/summary&gt; public void GetAll&lt;T&gt;() { //m...

1
голосов
2ответов
764 просмотров

Автоматически комментировать всех публичных участников в файле

Я включил предупреждения как ошибки, и теперь мне нужно прокомментировать XML все мои общедоступные методы. Просто чтобы скомпилировать мою программу, я просто хочу пока поставить заполнители. Есть ли способ автоматически добавлять XML-комментарии ко всем открытым членам класса или файла? ...

2
голосов
1ответов
1163 просмотров

Справочные префиксы в документации .NET XML

Я пытался полностью задокументировать все типы, методы, свойства и т. д. библиотеки классов, используя XML-комментарии, но столкнулся с любопытным эффектом, связанным с атрибутом cref (например, используемым тегами see). Следуя советам этой страницы MSDN , а также следуя различным другим пример...

15
голосов
3ответов
13649 просмотров

Использование атрибута cref комментария XML в C # с синтаксисом params

В C # я пытаюсь использовать для ссылки на сигнатуру метода, содержащую ключевое слово params. Я знаю, что это преобразует список параметров в массив, но я даже не могу понять, как ссылаться на массив в атрибуте CREF. Я ничего не нахожу в своих поисках, и никто из моих знакомых тоже не знает. К...

2
голосов
6ответов
5494 просмотров

XML-документация Visual Studio 2008

Кажется, я не могу найти параметр «Сборка» в папке «Свойства конфигурации» на страницах свойств моего проекта. Я везде искал, пытаясь понять, как это сделать. Я следовал указаниям здесь: http://msdn.microsoft.com /en-us/magazine/cc302121.aspx Более конкретно здесь: http://msdn.microsoft...

140
голосов
12ответов
132221 просмотров

Как иметь комментарии в IntelliSense для работы в Visual Studio?

В Visual Studio и C # при использовании встроенной функции, такой как ToString (), IntelliSense показывает желтое поле, объясняющее, что она делает. Как я могу получить это для функций и свойств, которые я пишу?

2
голосов
6ответов
433 просмотров

Комментарии XML: использовать или не использовать?

Мои коллеги редко (если вообще когда-либо) используют комментарии XML при работе над нашим программным обеспечением (не могу сказать, что я стал лучше). Недавно я увидел преимущества их использования, но действительно ли они того стоят, если код, который они документируют, написан четко (выразит...

10
голосов
4ответов
8853 просмотров

Как настроить текст автоматического комментирования в Visual Studio?

Когда я нажимаю на триггер функцию автоматического комментирования в Visual Studio (набирая "'' '" или "///"), появляется большая часть деталей комментариев XML, которые мне нравятся. Тем не менее, я обычно добавляю тег истории в документацию, чтобы я мог отслеживать и вносить изменения в метод ...

6
голосов
2ответов
2214 просмотров

Как связать / сгруппировать перегрузки в комментариях C # XML?

Есть ли способ в комментариях XML-документа для C # пометить две или более функций как перегрузки друг друга, чтобы они автоматически ссылались друг на друга? В идеале они также должны быть каким-то образом сгруппированы в документации, созданной замком из песка. Цель: часто мне нужно связать...

23
голосов
3ответов
7912 просмотров

Изменить фрагмент комментария XML по умолчанию в Visual Studio

Когда я нажимаю /// в Visual Studio, можно ли изменить полученный фрагмент следующим образом: /// &lt;summary&gt; /// /// &lt;/summary&gt; к этому ?: /// &lt;summary&gt;&lt;/summary&gt;

15
голосов
6ответов
2813 просмотров

Советы по комментированию XML для программирования на C #

Доброе утро, днем, вечером или ночью (в зависимости от вашего часового пояса) Это просто общий вопрос о комментариях XML в C #. Я никогда особо не комментировал свои программы, я всегда был более подробным средством именования переменных / свойств / методов и позволял коду говорить сам за себ...

1
голосов
1ответов
145 просмотров

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

Я уже несколько раз сталкивался с этой ситуацией. Я хочу указать тип в своих комментариях XML, но этот тип содержится в сборке, на которую не ссылается мой проект. В A.Dll (ссылки на B.DLL): using B; ///&lt;summary&gt;Hai I'm SomeClass and I use &lt;seealso cref="B.LoserClass"/&gt; to do m...

8
голосов
14ответов
2070 просмотров

Документация по коду: сколько это слишком много?

Насколько много документации по коду в исходном коде .NET? Немного предыстории: я унаследовал большую кодовую базу, о которой говорил в некоторых других вопросах, которые я разместил здесь, на SO. Одной из «особенностей» этой кодовой базы является класс God, единственный статический класс с&g...

28
голосов
2ответов
2672 просмотров

Что делает тег filterpriority в комментарии XML?

Я видел это во многих комментариях XML для классов в .NET Framework BCL, но никогда не мог найти документацию, объясняющую, что он делает. Например, при просмотре System.Object можно увидеть следующие комментарии: namespace System { /// &lt;summary&gt;Supports all classes in the .NE...

1
голосов
1ответов
336 просмотров

Определение framework goto показывает комментарии, они созданы из комментариев xml?

Недавно я был слегка удивлен, обнаружив, что мои тщательно подготовленные xml-комментарии не отображаются в intellisense для моих коллег. Поскольку я всегда использовал связанные сборки со ссылками на проекты, я не понимал, что вам нужно экспортировать XML-документ, чтобы получить доступ к этой ...

7
голосов
4ответов
3083 просмотров

Поиск отсутствующего содержимого комментариев XML с помощью Visual Studio

Во всем исходном коде C # у нас есть много комментариев, в которых отсутствует фактическое содержание, например: /// &lt;summary&gt; /// &lt;/summary&gt; или так: /// &lt;summary&gt; /// /// &lt;/summary&gt; или так: /// &lt;param Name="flag"&gt;&lt;/param&gt; К сожалению, V...

2
голосов
1ответов
677 просмотров

VS: атрибут для игнорирования отсутствующих комментариев XML при построении

У меня есть решение VS2008, использующее xml-документацию, и у нас есть предупреждения об ошибках, включенных в режиме выпуска (хорошая функция, IMHO); это приводит, однако, к длинным спискам ошибок «отсутствует xml-комментарий» для таких вещей, как каждый элемент (самоописывающегося) перечислен...

0
голосов
3ответов
1082 просмотров

Инструмент для переформатирования xml-комментариев (Visual Studio 2008)

знает ли кто-нибудь макрос или надстройку для VS 2008, которая переформатирует xml-комментарии? Был этот действительно умный CommentReflower для более старой версии VS, но я не смог найти релиз, поддерживающий VS 2008. Есть идеи? Заранее спасибо! Матиас

8
голосов
2ответов
1168 просмотров

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

Я использовал конструктор LINQ to SQL в Visual Studio для создания объектной модели базы данных. Теперь я хочу добавить XML-комментарии к каждому сгенерированному свойству, но не могу понять, как это сделать, не стирая свойства при следующем обновлении файла dbml. Как это сделать?

18
голосов
6ответов
3199 просмотров

.Net XML-комментарий в документации API

Есть ли простой способ создать документацию в стиле MSDN из выходных данных Visual Studio XML? У меня недостаточно терпения, чтобы настроить для этого хороший xslt, потому что я знаю, что я не первый, кто пересекает этот мост. Кроме того, я недавно пробовал построить замок из песка, но у мен...