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

Hrv*_*eša 48 documentation doxygen c++-cli documentation-generation

我正在开发一个项目,其中c ++/cli库主要来自ac#application.

有没有办法让c ++/cli中的代码注释在visual studio中对c#intellisence可见?

假设没有,那么记录c ++/cli代码的最佳方法是什么,以便从c#中更容易使用(当然在c ++/cli中)?您对XML评论vs doxygen与其他工具(哪些)的看法是什么?

小智 53

我已经让它工作如下:

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

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

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

这在Visual Studio 2008中适用于为.NET 3.5构建的程序集.

  • 也适用于Visual Studio 2010.唯一的区别是xml文件扩展名为".xdc" (3认同)