Описание тега xml-documentation
XML documentation is the way to generate automatic documentation from comments inside the code, to an XML formatted file that can be shown with any method, for e.g. a web page.
0
ответов
Как получить автоматизированную документацию для отображения моей реальной модели, а не IHttpActionResult
У меня есть этот контроллер, который возвращает продукт ///----------------------------------------------------------- /// <summary> Gets a product. </summary> /// /// <param name="locationid"> The locationid. </param> /// &l…
23 окт '14 в 15:30
0
ответов
XML документация не показывает изменений
Я начинаю с документации XML для методов, использующих это как руководство: https://msdn.microsoft.com/en-us/library/aa288481(VS.71).aspx Но похоже, что только когда вы вводите документацию в первый раз, она будет получена IntelliSense. Это заголово…
18 ноя '16 в 14:34
8
ответов
Как ссылаться на общие классы и методы в документации XML
При написании XML-документации вы можете использовать <see cref="something">something</see>, который работает конечно. Но как вы ссылаетесь на класс или метод с универсальными типами? public class FancyClass<T> { public string Fanc…
10 фев '09 в 12:50
4
ответа
Как я могу отключить определенное предупреждение для проекта C# в VS2012?
Я пытаюсь сгенерировать частичную документацию XML во время процесса сборки для проекта C# в VS2012. Когда я проверяю опцию файла документации XML в Project->Properties->Build, я получаю предупреждение о сборке для каждого открытого члена, у которог…
13 июн '13 в 13:25
1
ответ
Пропускать файлы XML-документации с помощью Web Deploy
Я пытаюсь опубликовать веб-сервис.NET с помощью Web Deploy. В настоящее время он включает файлы документации XML в пакет. Я снял флажок "XML-файл документации" на вкладке "Построение" свойств проекта в Visual Studio. Это останавливает публикацию это…
23 мар '12 в 16:03
1
ответ
Как добавить новые столбцы в XML-документацию по Web Api (страница справки)?
Я работаю с последней XML-документацией Web Api, предоставленной nuget в Visual Studio 2012. На самом деле я делаю свои комментарии XML и могу получить справочную страницу класса с такими свойствами: Name Description Type Additional information Мне …
03 дек '14 в 21:05
2
ответа
C# XML документация: как создавать заметки?
Я хочу добиться того же, что и в желтом поле "Примечание:" в разделе замечаний на этой странице MSDN в моей собственной документации. Я использую sandcastle и конструктор файлов справки sandcastle для создания справочного сайта из тегов документации…
20 июл '11 в 06:22
1
ответ
Как я могу предоставить документацию с XML-комментариями, не нарушая читабельность в браузере объектов?
Я работаю над улучшением некоторых наших комментариев к исходному коду, чтобы улучшить качество сгенерированных SandCastle справочных документов по библиотекам классов, добавив дополнительные записи, такие как или с /// <summary> /// Represent…
27 мар '12 в 17:12
2
ответа
Цель использования тегов <value> и <summary> в документации Visual Studio XML
Я работаю в C# в VS 2012, добавляя документацию XML в свой код, и я случайно включил правило StyleCop (в частности, SA1609), которое "проверяет, что открытое или защищенное свойство содержит заголовок документации с тегом значения ". Есть также друг…
09 апр '13 в 12:20
1
ответ
Как получить XML-комментарии для отображения в другом проекте (DLL)?
/// <summary> /// This method does something... /// </summary> public void DoSomething() { // code... } При использовании этого метода / класса и т. Д.... в другом.dll комментарии не отображаются.
27 окт '09 в 18:57
0
ответов
Комментирование исходного кода из файла XML
Обычно комментарии к документации используются для создания файла документации XML. Я искал противоположное, утилиту, которая могла бы взять ввод из XML-файла и поместить теги исходной документации в исходный файл. Есть ли что-нибудь важное для этог…
23 апр '18 в 16:46
1
ответ
Как изменить, загрузив и сохранив тот же файл XML
У меня проблема с изменением файла XML, когда я сначала загружаю, а затем сохраняю его с тем же путем и именем файла. Ниже мой код. Ошибка: "Доступ к пути C:\MyApp\Web.config запрещен. Если я изменю путь к xdoc.Save, чтобы он отличался от xdoc.Load,…
22 ноя '11 в 09:07
3
ответа
Рендеринг констант в документацию XML?
У меня есть 2 частных контеста и публичный метод: private const byte _minAge = 24; private const byte _maxAge = 29; public bool IsInAgeRange() { ... } Я добавляю документацию в формате XML и хотел бы, чтобы пользователи моего кода могли прочитать эт…
17 окт '12 в 10:37
1
ответ
Дополнительная пустая строка, отображаемая из <para></ para> и <para /> в VS2015CE, не может от нее избавиться
Когда я использую <para></para> тег в документации (в виде <para /> а также) в Visual Studio 2015 Community Edition я получаю дополнительную пустую строку, отображаемую во всплывающей подсказке IntelliSense (той, которая появляется…
04 янв '16 в 19:59
1
ответ
Правильно документируйте делегатов событий C#
Я надеюсь, что я использую правильную терминологию. Я хочу задокументировать публичное мероприятие Action<> делегат public event Action<int, int, WriteableBitmap, Exception> OperationDone Для этого я хочу, чтобы пользователь знал, что общего о…
20 окт '16 в 12:25
1
ответ
Как использовать документацию C# в других проектах?
Возможный дубликат: Как получить XML-комментарии для отображения в другом проекте (DLL)? У меня есть исходный код одной библиотеки, и каждая переменная, метод и т. Д. Там комментируется с помощью /// <summary> /// /// </summary> /// <…
09 дек '11 в 09:23
0
ответов
.NET (VB) XML Комментарии - примеры кода в резюме
Поддерживает ли Visual Studio (2017) intellisense примеры кода? Я пытаюсь поместить элементы кода в сводный элемент xml для комментирования методов. Когда я помещаю элемент "Код" в элемент "Сводка", intellisense не выполняет никакого выделения ключе…
01 сен '17 в 20:00
0
ответов
Лучшие практики для визуальной студии XML документации подклассов?
Программирование в VS 2013 C++ и наших стандартах doc требует XML-документации, отчасти поэтому комментарии появляются в IntelliSense. Моя проблема в том, что IntelliSense не наследует документацию от базовых классов, поэтому, если у меня есть что-т…
10 апр '17 в 12:37
1
ответ
Как объединить темы DITA И иметь вложенные темы в выводе HTML?
Это похоже на предыдущий вопрос, который я задавал, с одним вариантом. Я хотел бы знать, как объединить несколько тем в одну (используя @chunk), а затем иметь другие дочерние темы, к которым можно перейти в выводе HTML: Пример из реальной жизни: htt…
05 авг '12 в 15:37
1
ответ
Получить файлы XML-документации из сценария TFS Team Build
У меня есть настройка схемы репликации зависимостей в нашей среде TFS, основанная на http://geekswithblogs.net/jakob/archive/2009/03/05/implementing-dependency-replication-with-tfs-team-build.aspx. Это использует CompilationOutputs группа элементов,…
14 дек '10 в 15:20