Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to create Blazor components documentation from the parameter's comments?

With swagger, you can automatically create documentation of your API methods based on the comments.

Is it possible to do the same, but for Blazor components?

like image 979
Vencovsky Avatar asked Aug 31 '25 01:08

Vencovsky


1 Answers

If you are referring to the parameters for a Blazor component and you are wanting documentation (i.e. intellisense summary) then yes. In Visual Studio if you structure the code as follows it should show up when users reference the parameter from another Blazor component.

/// <summary>
/// Here is the description of the parameter InputValue and what it is used for
/// </summary>
[Parameter]
public string InputValue { get; set; }

In Visual Studio if you type /// it should auto-generate the format for you.

like image 186
Don Avatar answered Sep 02 '25 17:09

Don