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

时间:2015-10-07 14:13:11

标签: c# dll unity3d code-documentation

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

enter image description here

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

enter image description here

即使我记录了我的代码:

enter image description here

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

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

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

enter image description here

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

1 个答案:

答案 0 :(得分:9)

您需要包含XML文档文件。要创建它,您需要右键单击项目。在“构建”侧标签下,在底部的“输出”部分中,选中“XML文档文件”并保留其创建的路径。

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