如何在 DLL 中包含文档以在 Unity3D 中显示方法摘要?
How to include documentation in DLL to show method summary in Unity3D?
我正在为 Unity3D 开发一个 C# DLL 插件。实际上,MonoDevelop 工具提示(或 Visual Studio)仅显示我的方法的结构:
但是它没有像这样显示我的摘要:
即使我记录了我的代码:
有没有办法将我的文档包含在 DLL 中?
解决了这个问题(感谢 krillgar)
1 : 在 VisualStudio
中构建时创建 XML 文档文件
2:将此 XML 导入到 Unity3d 中的 Assets/Plugins 文件夹中
您需要包含 XML 文档文件。为了创建它,您需要右键单击该项目。在 "Build" 侧选项卡下,在底部的 "Output" 部分中,选中 "XML documentation file" 并保留它创建的路径。
当您将 DLL 带过来时,将那个 .XML 文件也带过来,这会将文档放入 Intellisense。 我不确定您是否能够使用 Unity 本身,但这就是您在 Visual Studio 中获得摘要的方式。 根据 probitaille 的评论,您可以添加XML 文件放入 Unity 中的 "Plugins" 文件夹,以将 comments/summaries 添加到 Unity 本身。
我正在为 Unity3D 开发一个 C# DLL 插件。实际上,MonoDevelop 工具提示(或 Visual Studio)仅显示我的方法的结构:
但是它没有像这样显示我的摘要:
即使我记录了我的代码:
有没有办法将我的文档包含在 DLL 中?
解决了这个问题(感谢 krillgar)
1 : 在 VisualStudio
中构建时创建 XML 文档文件2:将此 XML 导入到 Unity3d 中的 Assets/Plugins 文件夹中
您需要包含 XML 文档文件。为了创建它,您需要右键单击该项目。在 "Build" 侧选项卡下,在底部的 "Output" 部分中,选中 "XML documentation file" 并保留它创建的路径。
当您将 DLL 带过来时,将那个 .XML 文件也带过来,这会将文档放入 Intellisense。 我不确定您是否能够使用 Unity 本身,但这就是您在 Visual Studio 中获得摘要的方式。 根据 probitaille 的评论,您可以添加XML 文件放入 Unity 中的 "Plugins" 文件夹,以将 comments/summaries 添加到 Unity 本身。