Costanti di rendering nella documentazione XML?

Question

Ho 2 const private e un metodo pubblico:

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

public bool IsInAgeRange() { ... } 

sto aggiungendo documentazione XML, e vorrei che fosse meglio se gli utenti del mio codice potrebbe leggere questo in IntelliSense: Checks whether the age is within the allowed range (between 24 and 29).

La mia domanda è : C'è un modo per eseguire il rendering dei miei contenuti nella mia documentazione XML?

---

Le alternative mi è venuta in mente sono:

1. Basta scrivere 24 e 29 nella documentazione (manca la dipendenza ai valori reali)
2. Effettuare i const pubblico e aggiungere <see cref="MinAge"> e <see cref="MaxAge"> (riduce l'incapsulamento e rende la documentazione meno informativa)

Answer 1

Non penso ci sia modo di scrivere il valore reale di t egli costanti _minAge e _maxAge nella documentazione, ma si può fare riferimento a loro utilizzando il tag <see> come segue:

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

Ora, questo creerà un collegamento a queste costanti nella documentazione, in modo che quando si genera tuoi documenti e renderli in seguito, l'utente sarà in grado di fare clic su tali collegamenti e di fare riferimento alle costanti appropriate.