Skip to main content
 首页 » 编程设计

documentation之记录 C++/CLI 库代码以供 C# 使用之最佳工具和实践

2024年05月22日9jirigala

我正在开发一个项目,其中主要从 C# 应用程序使用 c++/cli 库。

有什么方法可以使 c++/cli 中的代码注释对 Visual Studio 中的 C# intellisence 可见吗?

假设没有,记录 c++/cli 代码以使其更容易在 c# 中使用(当然在 c++/cli 中)的最佳方法是什么?您对 XML 注释、doxygen 和其他工具(哪个)有何看法?

请您参考如下方法:

我已经让它工作如下:

  1. 对 C++/CLI header 条目使用 XML 样式注释。这意味着需要完整的 XML 注释(三斜杠注释,至少 <summary> 标记)

  2. 确保 C++ 编译器选项 Generate XML Documentation Files已开启。这应该生成一个 XML 文件,其中包含与程序集同名的文档 (MyDll.xml)。

  3. 确保 C# 项目引用程序集 MyDll.dll,其中 MyDll.xml 也存在于同一文件夹中。当您将鼠标悬停在程序集中的引用上时,MS Visual Studio 将加载文档。

这对我在 Visual Studio 2008 中为 .NET 3.5 构建的程序集有效。