为 Razor 组件添加 XML 文档注释

Question

有没有一种方法为Razor组件添加XML文档注释？我注意到微软的一些组件具有在IntelliSense中显示的文档：

然而，将通常的XML文档添加到代码后置部分类似乎不起作用：

/// <summary>
/// This is my component.
/// </summary>
public partial class MyComponent : ComponentBase
{
    // ...
}

还有其他实现此目标的方式吗，或者这种方法不被支持？

- 14207973

---

@lonix：链接的问题是关于向 .razor 文件添加文档的。我的问题是关于代码后台文件的。 - 14207973

Answer 1

在代码后端的部分类中添加常规的XML文档注释似乎不起作用。

对我而言它是有效的。但是当我刚才做了一个小测试时，我注意到这里有一种延迟。

添加“///summary”并进行重建一开始什么都没有发生。但是，在对组件进行了小的实际更改后，文本确实出现在Intellisense中。

我不完全确定这种刷新如何工作，但请耐心等待，它最终会出现。

- H H

---

谢谢@Henk。我已经测试了您的建议，并发现我在组件上编写的注释确实显示在我使用它们的页面的代码后端中，但并没有在页面的Razor编辑器本身中显示。然而，这可能是Visual Studio中Razor / HTML编辑器的问题。 - 14207973

我也可以在 Razor 代码中看到它们。 - H H

今天是2022年6月15日，我刚刚更新到了VS 17.2.4版本。但在Razor中并没有显示出来。此外，我希望能够在组件的Razor部分中放置它，而不需要使用code-behind文件。有时候我只有几行代码，不想麻烦地去写一个code-behind文件。 - MikeT