c# - 您如何获取 XML 文档以显示引用的 C# 库?

标签 c# visual-studio documentation-generation

假设您有一个包含多个函数的 C# 库,所有函数都用通常的 /// <summary> 记录。填写得很好。引用该项目将使函数和参数说明出现在 Visual Studio 上下文帮助中。但是,如果您不引用项目本身,而仅引用一个构建(可能还有其他包含文档的其他文件),是否可以进行此展示?

最佳答案

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

alt text

勾选此选项后,构建过程现在将在输出目录中构建一个额外的 XML 文件,其中包含所有 xml 文档 - 无论何时 Visual Studio 按文件引用程序集,它都会从该 XML 文件加载并显示智能感知文档(如果可以找到)。

alt text

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

关于c# - 您如何获取 XML 文档以显示引用的 C# 库?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4200802/

相关文章:

c++ - 我是否应该关心 4 级警告?

c# - await Task.FromResult 有什么好处吗?

c# - 用最小起订量模拟一个构造函数

c# - 复杂类型的方法参数验证

Visual Studio 中的 C++ 头文件

java - 为 servlet 支持的 API 生成文档的好方法是什么?

c# - Graphics.SmoothingMode 的奇怪行为

c# - 在 C# 中显示数据库 MySQL 中的数据被删除时的状态

oop - Doxygen 可以在成员组中包含函数但不记录它吗?

php - 在 PHP 中自动记录 REST API