Intellisense不会显示存储在外部文件中的XML注释

时间:2018-12-17 14:10:20

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

我遵循了this MSDN指南中的代码注释。

我发现我可以使用external files以更干净的方式获得相同的结果。

但是,我的IntelliSense不在Visual Studio上显示这些注释(在这种情况下,文件存储在应用程序的根目录中,与.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之类的工具正确显示了文档。

我做错什么了吗,或者这是默认行为? 我在网上搜索(特别是在这里),但没有找到解决该问题的合适方法。

1 个答案:

答案 0 :(得分:1)

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

给出用户建议的官方答案,这听起来像Visual Studio根本没有Visual Studio 2017那样的功能。