如何在DLL中包含文档以显示Unity3D中的方法摘要?

pro*_*lle 7 c# dll code-documentation unity-game-engine

我正在为Unity3D开发一个C#DLL插件.实际上,MonoDevelop工具提示(或Visual Studio)仅显示我的方法的结构:

在此输入图像描述

但它没有像我这样显示我的总结:

在此输入图像描述

即使我记录了我的代码:

在此输入图像描述

有没有办法在DLL中包含我的文档?

解决了这个问题(感谢krillgar)

1:在VisualStudio中构建时创建XML文档文件

在此输入图像描述

2:在Unity3d的Assets/Plugins文件夹中导入此XML

kri*_*gar 9

您需要包含XML文档文件.要创建它,您需要右键单击项目.在"构建"侧选项卡下,在底部的"输出"部分中,检查"XML文档文件"并保留其创建的路径.

当你带上你的DLL时,带上那个.XML文件,这将把文档放入Intellisense.我不确定你是否能够使用Unity本身,但这就是你在Visual Studio中获得摘要的方法.根据probitaille的评论,您可以将XML文件添加到Unity的"插件"文件夹中,以将您的评论/摘要添加到Unity本身.