Комментарии к документации для типов записей с первичными конструкторами в C#C#

Место общения программистов C#
Ответить
Anonymous
 Комментарии к документации для типов записей с первичными конструкторами в C#

Сообщение Anonymous »

Я могу объявить позиционную запись C# следующим образом:

Код: Выделить всё

public record Box(double Capacity);
что приводит к определению класса записи с именем Box со свойством с именем Емкость, а также к первичному конструктору для Box, который принимает параметр с именем Емкость. Теперь я хочу иметь возможность создавать независимые комментарии к документации для всех четырех элементов:
  • Тип записи Box.
  • Свойство Емкость.
  • Основной конструктор.
    Параметр конструктора Емкость.< /li>
Если я создам такой комментарий к документации:

Код: Выделить всё

/// 
/// A container for items.
/// 
/// 
How much the Box can hold
public record Box(double Capacity);
затем я получаю один и тот же сводный комментарий как для типа Box, так и для конструктора, а также один и тот же комментарий к параметру как для свойства Box, так и для параметра конструктора.
Как обсуждалось в этом вопросе, я могу создавать независимые комментарии для свойства и параметра конструктора, явно объявляя свойство:< /p>

Код: Выделить всё

/// 
/// A container for items.
/// 
/// 
Specifies the size of the box
public record Box(double Capacity) {

/// 
/// Returns the size of the box.
/// 
public double Capacity { get; init; } = Capacity;
}
И я могу создавать независимые комментарии для всех частей, также явно объявив конструктор:

Код: Выделить всё

/// 
/// A container for items.
/// 
public record Box {

/// 
/// Returns the size of the box.
/// 
public double Capacity { get; init; }

/// 
/// Creates a new Box instance.
/// 
/// 
Specifies the size of the box
public Box(double Capacity) {
this.Capacity = Capacity;
}
}
Но теперь я полностью потерял синтаксическую элегантность типа записи! Есть ли способ сохранить краткое объявление записи с позиционными параметрами при создании независимых комментариев документации для всех ее сгенерированных частей?


Подробнее здесь: https://stackoverflow.com/questions/782 ... in-c-sharp
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «C#»