c# - valid - ¿Representando constantes en la documentación XML?

see cref c#

Question

Tengo 2 consts privados y un método público:

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

public bool IsInAgeRange() { ... }

Estoy agregando documentación XML, y me gustaría que los usuarios de mi código pudieran leer esto en IntelliSense: Checks whether the age is within the allowed range (between 24 and 29).

Mi pregunta es: ¿hay una manera de representar mis constantes en mi documentación XML?

Las alternativas que he encontrado son:

1. Simplemente escriba 24 y 29 en la documentación (carece de la dependencia de los valores reales)
2. Haga públicos los consts y agregue <see cref="MinAge"> y <see cref="MaxAge"> (reduce la encapsulación y hace que la documentación sea menos informativa)

Answer 1

No creo que haya ninguna forma de escribir el valor real de las constantes _minAge y _maxAge en la documentación, pero puede referirse a ellas usando la etiqueta <see> siguiente manera:

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

Ahora, esto creará un enlace a esas constantes en su documentación, de modo que cuando genere sus documentos y los represente más adelante, el usuario podrá hacer clic en esos enlaces y referirse a las constantes apropiadas.