c# - 将常量呈现到 XML 文档中？

Question

我有 2 个私有(private)常量和一个公共(public)方法:

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 文档中？

---

我想到的替代方案是:

1. 在文档中简单地写下 24 和 29(不依赖于真实值)
2. 公开常量并添加<see cref="MinAge">和 <see cref="MaxAge"> (减少封装并减少文档的信息量)

Answer 1

为包含该值的每个常量添加一个摘要，然后引用这些注释:

/// <summary>24</summary>
private const byte _minAge = 24;
/// <summary>29</summary>
private const byte _maxAge = 29;

/// <summary>Checks whether the age is within the allowed range (between <inheritdoc cref="_minAge"/> and <inheritdoc cref="_maxAge"/>).</summary>
public bool IsInAgeRange() { ... }

我知道它仍然是重复的，但通过这种方式，您可以将常量注释保持在常量附近，即使常量完全在另一个文件中定义也是如此。