13

I'm working on a C# DLL plugin for Unity3D. Actually, the MonoDevelop tooltips (or Visual Studio) show only the structure of my method:

enter image description here

But it doesn't show my summary like this:

enter image description here

Even if I documented my code:

enter image description here

Is there a way to include my documentation in DLL?

SOLVED WITH THIS (thanks to krillgar)

1 : Create XML documentation file on build in VisualStudio

enter image description here

2 : Import this XML in your Assets/Plugins folder in Unity3d

probitaille
  • 1,899
  • 1
  • 19
  • 37
  • 2
    Possible duplicate of [How do you get XML comments to appear in a different project (dll)?](http://stackoverflow.com/questions/1632942/how-do-you-get-xml-comments-to-appear-in-a-different-project-dll) – Serlite Oct 07 '15 at 14:19
  • Oh yeah, looks like a similar question. – probitaille Oct 07 '15 at 14:40

1 Answers1

15

You need to include the XML documentation file. In order to create that, you need to right-click on the Project. Under the "Build" side tab, in the "Output" section at the bottom, check the "XML documentation file" and leave the path that it creates.

When you bring your DLL over, bring that .XML file along with it, and that will put the documentation into Intellisense. I'm not sure if you'll be able to use it Unity itself, but that is how you get the summary in Visual Studio. Per probitaille's comment, you can add the XML file into the "Plugins" folder in Unity to add your comments/summaries into Unity itself.

krillgar
  • 12,596
  • 6
  • 50
  • 86