Sabitleri XML belgelerine dönüştürmek mi istiyorsunuz?

Question

Ben 2 özel consts ve genel bir yöntem vardır:

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

public bool IsInAgeRange() { ... } 

Ben XML belgelerine ekliyorum ve benim kod kullanıcıları IntelliSense'de bu okuyabilseydi en iyisi gibi olacaktır: Checks whether the age is within the allowed range (between 24 and 29).

Benim sorum : Göçlerimi XML belgelerine yerleştirmenin bir yolu var mı?

1. Basitçe belgelerinde 24 ve 29 yazma
2. consts kamu yapın ve <see cref="MinAge"> ekleyin (gerçek değerlere bağımlılık yoksun): Ben ile geldim

   ---

   alternatifler ve <see cref="MaxAge"> (enkapsülasyonu azaltır ve belgeleri daha az bilgilendirici kılar)

Answer 1

Bunun gerçek değerini yazmanın bir yolu olduğunu düşünmüyorum O belgelerde _minAge ve _maxAge sabitleri, ancak aşağıdaki gibi <see> etiketini kullanarak onlara başvurabilirsiniz: dokümanlarınızı oluştururken böylece Şimdi

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

, bu, sizin belgelerinde bu sabitleri için bir bağlantı oluşturur ve daha sonra bunları render edersiniz, kullanıcı bu linkleri tıklayabilir ve uygun sabitlere başvurabilir.