【问题标题】:XML Comments stored inside external file is not showed by IntellisenseIntellisense 不显示存储在外部文件中的 XML 注释
【发布时间】:2018-12-17 14:10:19
【问题描述】:

我按照 this MSDN 指南评论我的代码。

我发现我可以使用external files 以更简洁的方式实现相同的结果。

但是,我的 IntelliSense 不会在 Visual Studio 上显示这些 cmets(在这种情况下,文件存储在应用程序的根目录中,与 .sln 文件处于同一级别)。 screen here

我按照以下步骤确保它不是一个有缺陷的项目:

  1. 我创建了一个新的 .NET 类库
  2. 我在项目中创建了一个名为 docs.xml 的新文件(如指南)
  3. 我已将此代码放入这个新文件中:

    <docs> <members name="class1"> <Class1> <summary> This is a test description </summary> </Class1> </members> </docs>

  4. 我已在项目设置中启用“XML 文档文件”并保留默认值 (bin\ClassLibrary1.xml)

  5. 我在类声明上方插入了 xml:
    /// <include file='docs.xml' path='docs/members[@name="class1"]/Class1/*' public class Class1 { }
  6. 构建解决方案
  7. 但是没有指定摘要。

在编译的 bin xml 文件中,此文件中指定的摘要存在,并且使用 SandCastle 等工具可以正确显示文档。

我做错了什么还是这是默认行为? 我在网上搜索(尤其是这里)并没有找到合适的解决方案。

【问题讨论】:

    标签: c# xml visual-studio-2017 xml-comments


    【解决方案1】:

    https://visualstudio.uservoice.com/forums/121579-visual-studio-2015/suggestions/12389910-include-external-xml-documentation-in-intellisense

    鉴于官方对用户建议的回答,听起来 Visual Studio 根本没有 Visual Studio 2017 的功能。

    【讨论】:

      猜你喜欢
      • 2010-11-23
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-12-17
      • 2010-11-03
      • 1970-01-01
      • 2010-09-18
      • 1970-01-01
      相关资源
      最近更新 更多