【问题标题】:xml commenting for tag helper intellisense标签助手智能感知的 xml 注释
【发布时间】:2017-05-25 05:52:07
【问题描述】:

我正在编写标签助手,但在通过智能感知在我的 Razor 视图中显示 XML cmets 时遇到问题。我认为下面的代码 sn-p 适用于标签本身:

namespace WebApplication.TagHelpers
{
    /// <summary>
    /// My Element
    /// </summary>
    public class MyTagHelper : TagHelper

我也尝试过数据注释(但不确定语法):

[DisplayName("My Tag")]
public class MyTagHelper : TagHelper

但这也行不通。我确定在依赖项和工具下的 project.json 中包含 Microsoft.AspNetCore.Razor.Tools 包。我还确定在我的 Visual Studio 环境中打开了 XML 文档。我试图寻找类似的帖子,但没有看到任何。任何帮助将不胜感激!

【问题讨论】:

  • 你的类和方法下面有没有上面没有标签的绿色波浪线吗?
  • 不,如果我删除数据注释或 XML cmets,它仍然可以正确编译。但是在我的 razor view 页面上,它提供了标签的自动完成功能,而不是修改后的摘要。 (它在悬停时显示完整的类名 WebApplication.TagHelpers.My,但没有别的)。
  • 您是否在定义了 taghelper 的项目中启用了 xmldocs 编译?
  • 就是这样!我在项目设置中错过了这一点。一旦我启用它,就会出现绿色的波浪线并且正确应用了评论。谢谢两位的帮助!

标签: asp.net-core intellisense tag-helpers


【解决方案1】:

从 cmets 提出这个问题,以便可以将问题标记为已回答:

在编译时启用 XML Docs 生成以在开发时提升 Summary cmets 以工作。


额外信息

如果您是 TagHelper 作者,打包您的项目应该会生成 XML 文档文件。

【讨论】:

    猜你喜欢
    • 2016-03-09
    • 2011-01-13
    • 2012-02-13
    • 2011-01-28
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-03-25
    相关资源
    最近更新 更多