c# - Intellisense 不显示存储在外部文件中的 XML 注释
问题描述
我按照这个MSDN 指南来评论我的代码。
我发现我可以使用外部文件以更干净的方式实现相同的结果。
但是,我的 IntelliSense 不会在 Visual Studio 上显示这些注释(在这种情况下,文件存储在应用程序的根目录中,与.sln
文件的同一级别)。
屏幕在这里
我按照以下步骤确保它不是一个错误的项目:
- 我创建了一个新的 .NET 类库
- 我在名为 docs.xml 的项目上创建了一个新文件(如指南)
我已将此代码放入此新文件中:
<docs> <members name="class1"> <Class1> <summary> This is a test description </summary> </Class1> </members> </docs>
我在项目设置中启用了“XML 文档文件”并保留了默认值 (
bin\ClassLibrary1.xml
)- 我在我的类声明上方插入了 xml:
/// <include file='docs.xml' path='docs/members[@name="class1"]/Class1/*' public class Class1 { }
- 构建解决方案
- 但是没有指定摘要。
在已编译的 bin xml 文件中,存在此文件中指定的摘要,并且使用诸如SandCastle
正确显示文档之类的工具。
我做错了什么还是这是默认行为?我在网上搜索(尤其是在这里)并没有找到解决问题的合适方法。
解决方案
鉴于对用户建议的官方回答,听起来 Visual Studio 根本没有 Visual Studio 2017 的功能。
推荐阅读
- javascript - 如何从 webpack 配置文件的 src 目录中排除 js 文件?
- ansible - Ansible 的 `become: yes` 有替代方案吗?
- c# - Automapper ValueTransformers from dynamic to a class
- sql - SQL query to get following result
- r - 如何从使用 ggplot() 制作的 QQ 图中删除异常值?
- swift - SwiftUI TextField 中的货币输入
- php - 使用 fread() 在 PHP 中读取 DBF 文件的奇怪行为
- swift - 使用 'case' 模式匹配直接返回结果
- python - Mystic - 如何正确停止优化
- javascript - movie.map 不是函数