有没有办法从参数的注释创建 Blazor 组件文档?

Ven*_*sky 4 c# blazor blazor-server-side blazor-client-side asp.net-blazor

使用 swagger,您可以根据注释自动创建 API 方法的文档。

除了 Blazor 组件之外,是否可以执行相同的操作?

小智 5

如果您指的是 Blazor 组件的参数并且需要文档(即智能感知摘要),那么可以。在 Visual Studio 中,如果按如下方式构造代码,当用户从另一个 Blazor 组件引用参数时,它应该会显示。

/// <summary>
/// Here is the description of the parameter InputValue and what it is used for
/// </summary>
[Parameter]
public string InputValue { get; set; }
Run Code Online (Sandbox Code Playgroud)

在 Visual Studio 中,如果您键入,///它应该会自动为您生成格式。

  • Swagger 是一个用于记录 API 的系统 - 这些 API 通常是从控制器和方法创建的。Blazor 组件与 Swagger 和 API 完全无关,并且永远不会从外部站点调用。完全不同的两个概念 (2认同)