如何在C#XML文档注释中指定参数的示例值？

如果您使用的是C#XML文档注释，并且您有一个

参数

来提供函数参数的描述，那么如何提供示例值（例如

“San Francisco”

或

5

）

以下是一个例子：

/// <summary>
/// Lookup EAN barcode value, return product data
/// </summary>
/// <remarks>Lookup an input EAN barcode and return key details about the product</remarks>
/// <param name="value">Barcode value</param>
/// <returns>JSON describing matching product data to the entered barcode</returns>
[HttpPost, Route("ean")]
public BarcodeLookupResponse EanLookup([FromBody]string value)

//
///查找EAN条形码值，返回产品数据
/// 
///查找输入的EAN条形码并返回有关产品的关键详细信息
///条码值
///描述将产品数据与输入的条形码匹配的JSON
[HttpPost，路线（“ean”）]
public BarcodeLookupResponse EanLookup（[FromBody]字符串值）

---

在这里，对于名为“value”的参数，我想提供一个示例EAN条形码，例如“QN1318481”来记录示例值（不是示例代码片段）

如果您需要它来使用Swagger生成OpenAPI文档，那么在

参数

标记中使用

示例

值是非常好的。根据（第3点）你可以写下

//
///查找EAN条形码值，返回产品数据
/// 
///查找输入的EAN条形码并返回有关产品的关键详细信息
///条码值
///描述将产品数据与输入的条形码匹配的JSON
[HttpPost，路线（“ean”）]
public BarcodeLookupResponse EanLookup（[FromBody]字符串值）

---

Swagger UI将自动使用此值，几天前刚刚尝试过同样的方法，效果很好

@RufusL在

中间使用

可以吗？@RufusL感谢您的反馈。我在上面添加了一个示例和说明。实际上，我试图为参数提供一个示例值，而不是一个示例代码段。这是在编辑器中为intellisense提供的吗？抱歉，我仍然不清楚您试图获得什么输出，以及在哪里。关于：

///条形码值（即“QN1318481”）

？此外，您可以考虑命名参数<代码>条形码< /代码>，而不是<代码>值>代码>，只是为了使它更清楚。@ Ruffl我想提供示例值，因为这是一个API，我们使用SavigGER生成OpenAPI文档，OpenAPI文档支持“示例值”。因为我们的OpenAPI是根据文档注释生成的，所以我们想看看是否有办法。你是说根本没有办法做到这一点吗？不，我在最后的评论中提供了一个例子。但这是您第一次提到OpenAPI及其“示例值”支持（我对此一无所知）。您可能应该用这些重要的细节更新您的问题，并将OpenAPI标记添加到您的问题中？例如，如果参数类型为MyObject，并且MyObject有两个属性MyProperty1和MyProperty2-如何为MyProperty1和MyProperty2提供示例值？@Abr只需放置一个单独的

my value

标记。答案上面链接的第4点显示：）谢谢！还有一个问题，对不起-这在.NET Framework的Swashback中有效吗？@Abr不适用于.NET FW，仅在.NET Core中试用