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

Question

我正在为 Unity3D 开发 C# DLL 插件。实际上，MonoDevelop 工具提示（或 Visual Studio）只显示了我的方法的结构：

但它并没有像这样显示我的摘要：

即使我记录了我的代码：

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

已解决（感谢 krillgar）

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

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

Answer 1

您需要包含 XML 文档文件。为了创建它，您需要右键单击项目。在“构建”侧选项卡下，在底部的“输出”部分中，检查“XML 文档文件”并保留它创建的路径。

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