代码文档,从常量中获取值

问题描述

有没有可能,有一个常数

 public const string MyString = "myValue"

在 xml 注释中获取它的值“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”。有没有办法实现这一点?

解决方法

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

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

Rendering constants into XML documentation?