ASP.NET Razor页面的代码文档注释？

Question

是否可以为razor页面（组件）添加代码文档注释？

我发现可以使用标准的页面参数文档注释（这些参数在@code块中声明），但我仍在寻找一种为组件（类）本身添加注释的方法。

对于参数，可以使用以下方法：

@code
{
   /// <summary> The Id of the selected account. </summary>
   [Parameter]
   public int SelectedAccount { get; set; }
}

因此，对于一个类，它应该是这样的：

@***
    <summary> This component renders a table. </summary>
***@

或者

@classcomment{
    <summary> This component renders a table. </summary>
}

有人知道方法吗？

- Stefan

Answer 1

简单的答案是“目前无法实现”。

我在 Razor 存储库上开了一个功能请求。如果您想要这个功能，请投票支持！

在这个功能实现之前，接受的答案是一个非常好的解决方法（但需要一个额外的文件，有点麻烦）。

- lonix

Answer 2

我认为仅从.razor文件中实现这一点是不可能的。但是，您可以添加一个“code-behind”文件，在其中放置文档（当然，这并不理想，因为文档与Razor代码分开）。

例如，让这个Component.razor成为您的示例：

<p>Some component</p>

@code
{
   /// <summary> The Id of the selected account. </summary>
   [Parameter]
   public int SelectedAccount { get; set; }
}

您可以使用组件的文档注释创建Component.razor.cs（文件名不重要，但遵循此方案是一个不错的约定）：

/// <summary> This component renders a table. </summary>
partial class Component { }

请注意，命名空间必须匹配（在此示例中，我没有使用任何命名空间，但您可以通过@namespace指令在.razor文件或文件夹结构中指定命名空间，并像往常一样在.cs文件中使用namespace块）。

- Jan Joneš

---

我也发现了这一点。显然这不是我想要的，但从技术上讲它回答了这个问题。可能仍然会对其他人有所帮助。 - Stefan