8
ответов

Способы синхронизировать интерфейс и реализацию комментируют в [закрытом] C#

Там автоматические пути состоят в том, чтобы синхронизировать комментарии между интерфейсом и его реализацией? Я в настоящее время документирую их обоих и не хотел бы вручную сохранять их в синхронизации. ОБНОВЛЕНИЕ: Рассмотрите этот code:...
вопрос задан: 5 May 2009 09:37
5
ответов

Как я экспортирую документацию кода в C# / VisualStudio 2008?

Я всегда считал обязательным для себя запись хороших комментариев к коду для классов и методов с синтаксисом XML C#. Я всегда ожидал легко мочь экспортировать их позже. Сегодня я на самом деле должен сделать так...
вопрос задан: 17 January 2018 17:32
4
ответа

Как генерировать документацию C# в файл HTML или CHM?

Существует ли способ генерировать читаемый файл документа из документации относительно кода непосредственно из Visual Studio? (также рассмотрение 2010) Пример кода:///<сводка>///Преобразовывают число в...
вопрос задан: 17 January 2018 17:36
4
ответа

Как зарегистрировать структуру XML-файлов

Когда дело доходит до документирования структуры XML-файлов... Один из моих коллег делает это, одним словом, таблица. Другой вставляет элементы в документ Word с комментариями как это: <...
вопрос задан: 17 June 2015 13:19
4
ответа

Документация XML для пространства имен

Вы записали бы xml-документ для пространства имен? И если да, как и где? Я думал бы, если это возможно, возможно, почти пустой файл как это:///<сводка>///Это пространство имен содержит материал///и...
вопрос задан: 1 May 2012 08:20
4
ответа

исключения автодокумента на методах в [закрытом] C#/.NET

Я хотел бы некоторый инструмент, предпочтительно тот, который включает VS 2008/2010, который пройдет мои методы и добавит XML-комментарии о возможных исключениях, которые они могут выдать. Я не хочу <сводка>...
вопрос задан: 7 June 2010 13:40
4
ответа

Комментарии Документации XML с Интерфейсами и [закрытым] классом (классами) с реализацией

Я документирую блок с помощью Комментариев Документации XML, из которых файл председателя будет создан с помощью Замка из песка. Мой блок содержит различные интерфейсы, каждый из которых реализован одним...
вопрос задан: 15 April 2009 08:59
3
ответа

Как использовать встроенные комментарии для документирования участников в.NET?

Как я могу зарегистрировать участника, встроенного в .NET? Позвольте мне объяснить. Большинство инструментов, которые извлекают документацию из комментариев, поддерживает некоторую встроенную документацию, где можно добавить резюме после участника...
вопрос задан: 19 January 2018 22:10
3
ответа

Что касается универсального типа универсального типа в документации XML C#?

Запись некоторой документации XML для класса помощника предиката. Но я не могу выяснить, что могу отослать к Выражению <Func <T, bool>>, не получая синтаксическую ошибку. Это даже возможно? Я имею...
вопрос задан: 15 January 2013 14:12
3
ответа

Как программно извлечь описание типа, которое показывается intellisense как подсказка

Когда я набираю какой-нибудь класс, например Консоль, затем нажмите Ctrl + пробел и intellisense показать подсказку "Класс System.Console Представляет стандартные потоки ввода, вывода и ошибок ...." Как программно получить этот текст ....
вопрос задан: 9 June 2010 11:25
3
ответа

Как я могу препятствовать тому, чтобы Visual Studio блокировала xml файлы документации в каталоге bin?

Мое решение для Visual Studio включает веб-приложение и приложение модульного теста. Мое веб-приложение использует log4net. Я хочу смочь использовать msbuild от командной строки для создания моего решения. Однако...
вопрос задан: 22 July 2009 19:25
3
ответа

Как использовать файлы документации XML

При использовании внешнего блока, который идет с файлом документации XML, как я заставляю Visual Studio находить его? При наличии файла документации XML, там программа, или xml преобразовывают файл или...
вопрос задан: 22 March 2009 09:47
2
ответа

Как включать xsd:documentation в класс C#, сгенерированный с XSD.exe?

Я использую xsd.exe для генерации класса C# от набора xsd файлов. xsd файл использует <xsd:documentation> тег для включения полезных описаний. Пример: <xsd:complexType...
вопрос задан: 25 January 2018 01:58
2
ответа

Как сослаться на универсальные классы и методы в xml документации

При записи xml документации можно использовать <видят cref = "что-то">, что-то </видит>, который работает, конечно. Но как Вы ссылаетесь на класс или метод с универсальными типами? общедоступный класс...
вопрос задан: 21 January 2013 16:28
2
ответа

Как должен комментарии для методов интерфейса и методов класса отличаться

Я столкнулся с этой дилеммой при работе над веб-приложением ASP.net с помощью Фабрики программного обеспечения веб-клиента (WCSF) в C#, и то же могло относиться к другой платформе и языкам. Моя ситуация похожа на это:...
вопрос задан: 5 March 2010 19:21
2
ответа

Как сделать cref к перегрузкам метода в тег <seealso> в C#?

Я вижу в ссылках MSDN, таких как "Перегрузки CompareOrdinal". Как я могу записать такую ссылку в C#? Я попробовал: <seealso cref = "MyMethod"> Перегрузки MyMethod </seealso>, Но компилятор дает мне...
вопрос задан: 7 January 2009 09:26
1
ответ

Как я ссылаюсь на ключевое слово C# в документации XML?

<видят cref =, "переключатель"/>, например, не работает - я получаю компиляцию, предупреждающую: XML-комментарий на... имеет синтаксически неправильный Контекст 'переключателя' атрибута cref для тех, кому интересно......
вопрос задан: 29 June 2012 18:33
1
ответ

Как получить XML-комментарии для отображения в другом проекте (DLL)?

/// < summary > /// Этот метод что-то делает ... /// < / summary > public void DoSomething () {// code ...} При использовании этого метода / класса и т. д. ... в другом .dll комментарии не отображаются ...
вопрос задан: 16 February 2012 21:36
1
ответ

Документирование Замка из песка использования: Обращение к использованию перечисления значений <видит>

Я использую Замок из песка 2.4.10520 и Разработчика Справочного файла Замка из песка 1.8.0 для генерации .chm справочного файла. В моей документации я использую, <посмотрите> теги. Если я пытаюсь относиться, перечисление как <см. cref = "...
вопрос задан: 1 May 2010 14:38
1
ответ

Как отослать к перечислимым константам в c# xml документы

Я хочу зарегистрировать значение по умолчанию введенного поля перечисления:///<сводка>///значение по умолчанию <см. cref = "Ориентация. Горизонтальный"/>.///</сводка> общедоступная Ориентация...
вопрос задан: 30 April 2010 14:11
1
ответ

C#, XmlDoc: Как сослаться на перегрузки метода

Если у меня есть эти два Нечто общественности методов, Добираются (строковая панель) {...} Общедоступные Нечто Добираются (международная панель) {...} И запишите, что эта часть xml документации относительно другого метода///<сводка>///Имеет завершен
вопрос задан: 18 August 2009 12:42
1
ответ

Куда поместить комментарии документации XML для приложенного свойства?

Принятие мне определили приложенное свойство как этот: общедоступная статическая строка GetMyProperty (DependencyObject obj) {возврат (строка) obj. GetValue (MyPropertyProperty);} общественность...
вопрос задан: 3 August 2009 20:27
1
ответ

Ссылочный универсальный комментарий

Я задавался вопросом, возможно ли сослаться на динамическое универсальное имя класса в комментарии, и это условно решило в IDE? Простой пример базового класса://<сводка>//Получает все...
вопрос задан: 30 May 2009 23:17
1
ответ

Классы реализации могут “наследовать” XML-комментарии от своих реализованных интерфейсов?

Любопытный вопрос. Я использую Замок из песка Microsoft для генерации документации из XML-комментариев в моем коде C#. Несколько из моих классов реализуют интерфейсы, которые уже прокомментировали...
вопрос задан: 6 April 2009 16:29
1
ответ

Извлеките комментарии xml для общедоступных участников только

Я использую комментарии xml для документирования общедоступных, а также внутренних и членов парламента, не занимающих официального поста моих компонентов. Я хотел бы упаковать сгенерированные XML-файлы документации с блоками компонента чтобы к...
вопрос задан: 8 March 2009 22:53
0
ответов

Какой тег комментария к документации на C # xml используется для «true», «false» и «null»?

Какой тег комментария к документации на C # xml используется для литералов true, false и null? В собственной документации Microsoft эти литералы выделены жирным шрифтом. Например, документация для ...
вопрос задан: 24 March 2019 18:04
0
ответов

Можно ли сгруппировать XML документацию из списка тегов в C #

Я использую Doxygen для моей проектной документации C #. И теперь мне нужно сделать документацию для одного метода с таблицей. Документация MSDN об этом теге очень плохая: https: //docs.microsoft.com/en-us / ...
вопрос задан: 26 February 2019 10:42
0
ответов

Показать < возвращает > тег XML в визуальную студию intellisense

Я добавил < Returns > XML-тег для некоторых из моих методов, но я не вижу его содержимое в IntelliSense. Вот мой код: /// < summary > /// мы все живем в желтой сводке /// < / summary > // ...
вопрос задан: 5 February 2019 17:00
0
ответов

Как добавить перерыв линии в C #. Чистая документация

Это должно быть упрощению WAAAAY. ... Я хочу добавить «кодированную» перерыв линии в документацию XML в моем коде /// /// получим читаемый человеком вариант SQL, где заявление о поисках ...
вопрос задан: 21 August 2017 16:18
0
ответов

с помощью см. cref с символами <> в документации XML? [дубликат]

Возможный дубликат:Как ссылаться на общие классы и методы в xml-документации. Я использовал тег see cref, и он отлично работает, но теперь мне нужно включить общий список string [] в ...
вопрос задан: 23 May 2017 12:34