- Home /
Custom Documentation for Monodevelop
Hi. I am writing a rather large class with functions, and I have a list of values that tell me which is which. However, whenever I want to check it, I have to manually open up the function in which I have written it. I know there is a way in Eclipse, but is there a way in Monodevelop to write your own custom documentation?
Answer by LEDWORKS · Apr 02, 2014 at 07:20 PM
Intellisense my good friend! :)
Comment your code with /// or does MonoDevelop not have this functionality? I use VisualStudio and previously Unitron.
I do use //
But in Eclipse, there is a way to make these show up in a popup while you are typing an instance of that function. Currently in $$anonymous$$onodevelop, the only information that appears in the popup is the names of the variables that I need to input.
You need three / two is only commenting, three of them will create a default documentation that is often laughable as it tries to use the name of the method and convert it to a sentence.
Once you have it then you type the method and the info shows up.
This is what I get:
/// <summary>
/// $$anonymous$$ies the method.
/// </summary>
/// <returns>The method.</returns>
/// <param name="first">First.</param>
/// <param name="second">Second.</param>
float $$anonymous$$y$$anonymous$$ethod(float first, string second){}
Ah, thanks! I thought LEDWOR$$anonymous$$S has just made a typo. I'll try the /// method tomorrow.
Your answer
Follow this Question
Related Questions
Return a custom class from function 1 Answer
Magic Spell Types - SpellType.Fire/Water/Earth? 1 Answer
How can I access a function without knowing the script/class name to which it belongs? 1 Answer
How do I set a custom return value when using a custom class? 1 Answer
Inheriting class documentation with Unity-Monodevelop 1 Answer