Вопросы по теме 'xml-comments'
VS: Атрибут для игнорирования отсутствующих комментариев XML при построении
У меня есть решение VS2008 с использованием XML-документации, и у нас есть предупреждения, поскольку ошибки включены для режима выпуска (хорошая функция, ИМХО); однако это приводит к длинным спискам ошибок «отсутствующий комментарий xml» для таких...
683 просмотров
schedule
14.11.2022
Справочные префиксы в документации .NET XML
Я пытался полностью задокументировать все типы, методы, свойства и т. Д. Библиотеки классов, используя XML-комментарии, но столкнулся с любопытным эффектом, связанным с атрибутом cref (например, используемым тегами see ). Следуя советам этой...
1198 просмотров
schedule
09.04.2023
Комментарии XML - должны ли ссылки быть полностью квалифицированными?
В принципе, когда действительно необходимо (если вообще необходимо) использовать полностью квалифицированный xml, см. Ссылку:
<see cref="T:MyNamespace.Sub.MyType"/> //Option 1
<see cref="T:MyType"> //Option 2
А как насчет ссылок...
4608 просмотров
schedule
31.07.2022
Можно ли заставить VS указывать тип при построении xml-комментариев?
Я пытаюсь создать документацию для своего кода и использую для этого xml-комментарии. Когда класс задокументирован следующим образом:
/// <summary>
/// Main presentation window
/// </summary>
public partial class mainWindow : Form
{...
40 просмотров
schedule
09.01.2024
XML-документация по методу TransformText шаблона T4
У нас есть несколько проектов, которые используют шаблоны времени выполнения T4. Файлы шаблонов T4 (.tt) создают сгенерированные файлы .cs с тем же именем. Они содержат TransformText() метод и ToStringHelper() метод, которые не содержат...
1003 просмотров
schedule
19.06.2023
Как добавить XML-комментарии к автоматически сгенерированным классам, созданным Entity Framework, при использовании подхода Model-First?
Я добавил информацию в свойство Documentation.Summary в графическом редакторе, но она не добавляется в сгенерированные классы. Есть какой-либо способ сделать это?
1639 просмотров
schedule
16.02.2023
Шаблон EntityFramework t4 — XML-документация
У меня есть следующая проблема с моим файлом EDMX.
В нем я написал некоторую документацию для свойств, а также для объектов, но шаблон t4 моего EF 5 не генерирует эти значения.
Мой желаемый результат должен быть
public class Person
{
///...
2201 просмотров
schedule
15.02.2023
Комментарии XML для двумерного массива, допускающего значение NULL
Как правильно указать XML-комментарии для двумерного массива нулевых двойников? Следующее дает мне синтаксическую ошибку.
/// <returns>The <see cref="double[,]"/>.</returns>
public double?[,] Get2DArray()
{
...
}
Если...
315 просмотров
schedule
12.02.2022
Отображение общих параметров комментариев XML в Intellisence для статического метода
У меня возникли проблемы с получением общих параметров для двух приведенных ниже методов для отображения типов в Intellisence.
Для IEnumerable<T> я просто хочу, чтобы он отображался как double .
Что касается перегрузки...
504 просмотров
schedule
01.02.2023
Как комментировать атрибуты внутри тега XML?
Можно ли прокомментировать один или несколько атрибутов внутри тега XML? Что-то вроде /* */ из C.
Я пытался использовать <!-- --> , но безуспешно.
<element
attribute1="value1"
attribute2="value2"
<!--...
26627 просмотров
schedule
19.04.2023
С# комментарий xml, cref не может ссылаться на метод, определенный в базовом классе
В моей кодовой базе есть метод, определенный в базовом классе, базовый класс наследуется, но метод еще не переопределен. Этот метод, скорее всего, будет переопределен в будущем, чтобы добавить его в базовую реализацию.
Моя установка выглядит...
1639 просмотров
schedule
13.08.2022
Как XML-комментарии работают между проектами в одном решении
Я настраиваю xml-комментарии через свойства проекта в решении. Я хочу, чтобы эти комментарии были видны в другом проекте в том же решении. Однако ссылки на проект и xml в bin рядом с .exe недостаточно.
Я попытался добавить жесткую ссылку в другую...
146 просмотров
schedule
07.10.2023