# XML comments for UnityEngine/Editor DLL

**URL:** https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588
**Category:** Documentation
**Tags:** Unity-Documentation
**Created:** [July 31, 2014, 7:58pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588 "2014-07-31T19:58:03Z")
**Posts on this page:** 10
**Page:** 1

<div class="post-metadata">

### Author: ![Demigiant](https://dub1.discourse-cdn.com/unity/user_avatar/discussions.unity.com/demigiant/32/255664_2.png) [@Demigiant](https://discussions.unity.com/u/Demigiant)
#### Post date: [July 31, 2014, 7:58pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/1 "2014-07-31T19:58:03Z")

</div>

I think it’s truly time for the UnityEngine and UnityEditor DLL to be published with complete XML documentation, so that IntelliSense can give you full infos instead than showing methods and properties that have no description at all.

---

<div class="post-metadata">

### Author: ![khan-amil](https://dub1.discourse-cdn.com/unity/user_avatar/discussions.unity.com/khan-amil/32/358002_2.png) [@khan-amil](https://discussions.unity.com/u/khan-amil)
#### Post date: [November 27, 2014, 1:48pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/2 "2014-11-27T13:48:16Z")

</div>

Would be good indeed.

---

<div class="post-metadata">

### Author: ![Rasmus\_Selsmark](https://avatars.discourse-cdn.com/v4/letter/r/67e7ee/32.png) [@Rasmus\_Selsmark](https://discussions.unity.com/u/Rasmus_Selsmark)
#### Post date: [November 27, 2014, 11:37pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/3 "2014-11-27T23:37:56Z")

</div>

Agree. And I really hope we will have this soon-ish. Haven’t looked into the actual details of implementing it though

---

<div class="post-metadata">

### Author: ![User340](https://avatars.discourse-cdn.com/v4/letter/u/bbe5ce/32.png) [@User340](https://discussions.unity.com/u/User340)
#### Post date: [November 28, 2014, 3:31am UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/4 "2014-11-28T03:31:32Z")

</div>

Someone’s already doing it. Can’t remember exactly who though.

---

<div class="post-metadata">

### Author: ![khan-amil](https://dub1.discourse-cdn.com/unity/user_avatar/discussions.unity.com/khan-amil/32/358002_2.png) [@khan-amil](https://discussions.unity.com/u/khan-amil)
#### Post date: [November 28, 2014, 10:05pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/5 "2014-11-28T22:05:04Z")

</div>

> [@Rasmus Selsmark](#):
>
> Agree. And I really hope we will have this soon-ish. Haven’t looked into the actual details of implementing it though

Glad to hear that!

---

<div class="post-metadata">

### Author: ![Demigiant](https://dub1.discourse-cdn.com/unity/user_avatar/discussions.unity.com/demigiant/32/255664_2.png) [@Demigiant](https://discussions.unity.com/u/Demigiant)
#### Post date: [November 28, 2014, 10:16pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/6 "2014-11-28T22:16:57Z")

</div>

> [@Rasmus Selsmark](#):
>
> Agree. And I really hope we will have this soon-ish. Haven’t looked into the actual details of implementing it though

Good to know 🙂 You mean who could implement it? The details otherwise are pretty simple: you just need to write correct [XML comments](http://msdn.microsoft.com/en-us/library/vstudio/b2s063f7%28v=vs.100%29.aspx) above each method/property then tell your editor to also export the XML documentation when compiling the library.

---

<div class="post-metadata">

### Author: ![Rasmus\_Selsmark](https://avatars.discourse-cdn.com/v4/letter/r/67e7ee/32.png) [@Rasmus\_Selsmark](https://discussions.unity.com/u/Rasmus_Selsmark)
#### Post date: [November 28, 2014, 10:32pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/7 "2014-11-28T22:32:35Z")

</div>

> [@Demigiant](#):
>
> Good to know 🙂 You mean who could implement it? The details otherwise are pretty simple: you just need to write correct [XML comments](http://msdn.microsoft.com/en-us/library/vstudio/b2s063f7%28v=vs.100%29.aspx) above each method/property then tell your editor to also export the XML documentation when compiling the library.

Yeah, sounds easy I know, but we don’t have the documentation inside the C# files for e.g. following reasons:

1. Allow easy translation into other (human) languages
2. Our C# files is to large extend an auto-generated layer on top of the C++ core, which increases the maintanability overall

But yes, I also miss the intellisense tooltips when working with Unity myself.

Haven’t taken a closer look, but the uIntelliSense asset store package claims to have implemented this: [https://www.assetstore.unity3d.com/en/#!/content/22906](https://www.assetstore.unity3d.com/en/#!/content/22906)

Rasmus

---

<div class="post-metadata">

### Author: ![Demigiant](https://dub1.discourse-cdn.com/unity/user_avatar/discussions.unity.com/demigiant/32/255664_2.png) [@Demigiant](https://discussions.unity.com/u/Demigiant)
#### Post date: [November 28, 2014, 11:24pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/8 "2014-11-28T23:24:12Z")

</div>

Ouch, I totally understand now. Cool about uIntelliSense by the way, will check it out.

---

<div class="post-metadata">

### Author: ![mdrotar](https://avatars.discourse-cdn.com/v4/letter/m/7ab992/32.png) [@mdrotar](https://discussions.unity.com/u/mdrotar)
#### Post date: [January 24, 2015, 6:36pm UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/9 "2015-01-24T18:36:55Z")

</div>

I wrote a tool to parse the html docs and convert them into XML files to enable intellisense code hints. The same thing as what uIntellisense does but I am providing the XML files for free. This should work well enough until Unity gets around to providing official support for it.

[https://github.com/drostar/UnityIntelliSenseDocumentation](https://github.com/drostar/UnityIntelliSenseDocumentation)

---

<div class="post-metadata">

### Author: ![Rasmus\_Selsmark](https://avatars.discourse-cdn.com/v4/letter/r/67e7ee/32.png) [@Rasmus\_Selsmark](https://discussions.unity.com/u/Rasmus_Selsmark)
#### Post date: [January 25, 2015, 10:26am UTC](https://discussions.unity.com/t/xml-comments-for-unityengine-editor-dll/545588/10 "2015-01-25T10:26:25Z")

</div>

Thanks @mdrotar , works here on my Unity 4.6 on Mac as well!

FYI, the process of installing on Mac/MonoDevelop is:  
Copy your XML files to /Applications/Unity/Contents/Frameworks/Managed and /Applications/Unity/Contents/UnityExtensions/Unity/GUISystem/4.6.0

Should be fairly easy to implement now (we already have the documentation internally in XML files), and would think it should be possible to get into Unity 5.x soon. Your XML files will be valuable for 4.6 anyways, so thanks again.

Best regards, Rasmus
