Подтвердить что ты не робот

Рендеринг констант в документации XML?

У меня есть 2 частных consts и общедоступный метод:

private const byte _minAge = 24;
private const byte _maxAge = 29;

public bool IsInAgeRange() { ... }

Я добавляю XML-документацию и хотел бы, чтобы пользователи моего кода могли прочитать это в IntelliSense: Checks whether the age is within the allowed range (between 24 and 29).

Мой вопрос: Есть ли способ сделать мои константы в моей документации XML?

Альтернативами, которые я придумал, являются:

  • Просто напишите 24 и 29 в документации (отсутствует зависимость от реальных значений)
  • Сделать consts общедоступным и добавить <see cref="MinAge"> и <see cref="MaxAge"> (уменьшает инкапсуляцию и делает документацию менее информативной)
4b9b3361

ОТВЕТЫ

Ответ 1

Я не думаю, что есть какой-либо способ записать фактическое значение констант _minAge и _maxAge в документации, но вы можете обратиться к ним с помощью тега <see> следующим образом:

/// <summary>
/// Checks whether the age is within the allowed range (between <see cref="_minAge" /> and <see cref="_maxAge" />).
/// </summary>

Теперь это создаст ссылку на эти константы в вашей документации, так что, когда вы сгенерируете свои документы и впоследствии их создадите, пользователь сможет щелкнуть по этим ссылкам и будет ссылаться на соответствующие константы.