代码之家 › 专栏 › 技术社区 › MPelletier

如何为引用的C库显示XML文档?

documentation-generation visual-studio c#

MPelletier · 技术社区 · 14 年前

假设您有一个C#库,它有几个函数,所有这些函数都用通常的 /// <summary> 填得很好。引用项目将使函数和参数描述显示在Visual Studio上下文帮助中。但是,如果您不引用项目本身,仅仅引用一个构建(可能还有其他包含文档的文件),那么是否有可能显示此内容?

1 回复 | 直到 14 年前

Justin 14 年前

是的-库需要在选中“XML文档文件”复选框的情况下构建(在项目属性页中)

alt text

勾选此选项后,生成过程现在将在包含所有XML文档的输出目录中生成一个额外的XML文件—每当Visual Studio逐文件引用程序集时,它将从该XML文件加载并显示intellisense文档(如果可以找到)。

alt text

您应该将此文件与已编译的库一起(在同一目录中)分发。

推荐文章

Helic · 引用项目中的Visual Studio生成事件

11 月前

Fardin Jim · React中的HandleError

11 月前

korri123 · 参见C中std::unordered_map的哈希分布++

11 月前

Sam · 返回Visual Studio中文档注释中的标记

1 年前

Natty · Visual Studio中缺少“代码覆盖率结果”

1 年前

xTMx · 如何修复恢复自定义Nuget软件包的问题?

1 年前

Jay · 如何在Visual Studio中强制执行IDE0300诊断?

1 年前

CCarter · 只能在设计器中DependencyObject的DependencyProperty上设置显示“Binding”的WPF ICommand DependencyProperties[重复]

1 年前

Paulo Cardoso · 有什么不同的形式可以使用Visual Studio面板吗?关闭

1 年前

Max · VS 2022中的缩放级别在哪里

1 年前