代码文档，从常量中获取值答案

【问题标题】：code documentation, get value from constant代码文档，从常量中获取值
【发布时间】：2021-03-01 16:39:38
【问题描述】：

有没有可能，有一个常数

 public const string MyString = "myValue"

在 xml cmets 中获取其值“myValue”？我对此很感兴趣，因为它可以生成 swagger 文档。

    /// <summary>
    /// Creates a new resource.
    /// </summary>
    /// <param name="request">The request object.</param>
    /// <returns code="200">The id of the new resource.</returns>
    /// <response code="400">
    /// <see cref="Errors.BadRequestCodes.MyString"/><para/>
    /// </response>

这是一个记录端点的例子。在 swagger ui 中，我实际上看到的是“Errors.BadRequestCodes.MyString”，而不是在 400 状态代码部分看到消息“myValue”。有什么方法可以实现吗？

【问题讨论】：

大多数这些关于 XML doc 的问题背后的意图似乎是避免字符串重复。我还没有找到解决办法。我想将代码属性中的文本也用于文档，例如[Description("This property is about blah blah")]，在某些工具中显示，以及像 /// <summary>This property is about blah blah</summary> 这样的属性 XML 文档，而不复制字符串文本。

标签： c# xml-documentation microsoft-documentation

【解决方案1】：

您是否尝试过使用<inheritdoc>，并在第一个文件中添加 const 值，然后在第二个文件中引用它？

https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/inheritdoc

Rendering constants into XML documentation?

【讨论】：