- Home /
monodevelop documentation doesn't show all tags
I am trying to document my code so that it is possible to see what everything does simply by hovering over the function name (like eclipse does with javadocs). I know the formatting that is required in C#, but monodevelop (or Intellisense I guess) only shows the first tag, not the others, and even then it doesn't display quite correctly. I am using Unity 5.1.0f3 64 bit and MonoDevelop 4.0.1.
/// <summary>
/// Initializes a new instance of the <see cref="Product"/> class.
/// </summary>
/// <param name="namae">Namae.</param>
/// <param name="desc">Desc.</param>
/// <param name="lessons">Lessons.</param>
/// <param name="urls">Urls.</param>
public Product(string namae, string desc, string[] lessons, string[] urls){
this.name=namae;
this.description=desc;
this.lessons=lessons;
this.urls=urls;
}
The above code only displays the constructor definition and the summary tag. The remaining info is completely disregarded. Any idea as to how I can fix this?
Thanks!
Answer by Elric · Aug 15, 2015 at 07:28 AM
I got it working by removing ///< /summary>
line or whole summary tag. It's not a fix but workaround. Actual summary can be replaced by < para>text here< /para>. It behaves somehow strange but anyway better than nothing. For example:
/// <para>First text</para>
/// <para>Second text</para>
/// <returns>returns int</returns>
/// <param name="param1">int param1</param>
will result in tooltip:
Summary
First text
param1:int param1
Second text
Returns:
returns int
Without any < para> or < summary> parameters are displayed at the end
Your answer
Follow this Question
Related Questions
Namespace visible in Assembly Browser, but can't autocomplete in MonoDevelop? 1 Answer
Unity3d and monodevelop c# scripting on ubuntu 16.04 IntelliSense problems 0 Answers
Enhance MonoDevelop's intellisense tooltip 1 Answer
Monodevelop not showing autocomplete / intellisense in Mac OS 10.6.7 8 Answers
Monodevelop Autocomplete/Intellisense and UnityScript. 3 Answers