【问题标题】:Is there a way to create Blazor components documentation from the parameter's comments?有没有办法从参数的注释中创建 Blazor 组件文档?
【发布时间】:2020-03-19 14:50:01
【问题描述】:

使用 swagger,您可以基于 cmets 自动创建 API 方法的文档。

是否可以这样做,但对于 Blazor 组件?

【问题讨论】:

  • 请求库在 Stack Overflow 上是特别离题的,所以我删除了这个问题。询问是否有可能是一个话题,如果人们知道图书馆,他们可以回答。您可能希望通过您所做的任何研究来更新您的问题以避免投票,但这当然是可选的。
  • @HereticMonkey 谢谢,我已经搜索过了,但我找不到办法。每次我用文档或文档这个词输入 Blazor 时,我都会在 lblazor 文档中结束

标签: c# blazor blazor-server-side blazor-client-side asp.net-blazor


【解决方案1】:

如果您指的是 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; }

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

【讨论】:

  • 但是文档会通过swagger吗?那是 OP 的问题。
猜你喜欢
  • 2021-09-24
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-06-03
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多