代码之家 › 专栏 › 技术社区 › 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

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

推荐文章

Miguel Mesquita Alfaiate · 将nuget包从项目绑定到DLL中,以允许在第三方项目中重用

1 年前

kaiselwyvrn · 我无法打开Visual Studio项目

1 年前

David Thielen · ReSharper是否有一个重构程序来消除结束html标记

1 年前

NAM3L3SSRJ · 如何在C语言中创建一个方法或函数,在超市销售时减少数据库中的库存

2 年前

TheMixy · Visual Studio-将文本粘贴到cshtml中会删除文本

2 年前

LeeJunYoung · Visual Studio 2022发布菜单中没有ftp菜单。如何通过ftp发布?

2 年前

Cobra_Fast · 如何查找不必要的空运算符?

2 年前

Josep Ramon Ribera · 如何在WPF(C#)中包含条形图?

2 年前

Tajca-sus3 · 自动完成在新的Visual Studio 2022 For UNITY中不起作用

2 年前

lolorekkk · 面板插入。NET WinForm

2 年前