Any comments starting with and following the <cref> tag are not rendering. Any <param> tags are not rendering. If there is a <typeparam> tag, no comments are rendered.
Does Consulo support all of C#'s documentation comments? If not, I'll open up another issue as a feature request to support the tags.
Here is the example script I used for testing:
using System;
public class Program
{
public static void Main(String[] args)
{
Console.WriteLine("Hello World!!!");
SomeMethod("test", 1, 3.5);
SomeGenericMethod<string>("test", "test2", 3);
}
/// <summary>
/// This is a description for the method. It exists in the <see cref="Program"/> class.
/// </summary>
/// <param name="param1">This is a description for the parameter. It is a string.</param>
/// <param name="param2">This is a description for the second parameter. It is an integer.</param>
/// <param name="param3">This is a description for the third parameter. It is a double.</param>
public static void SomeMethod(string param1, int param2, double param3)
{
Console.WriteLine("Just a method here");
}
/// <summary>
/// This is a description for the method. It exists in the <see cref="Program"/> class.
/// </summary>
/// <typeparam name="T">Supply any type here</typeparam>
/// <param name="param1">This is a string parameter</param>
/// <param name="param2">this is a generic parameter</param>
/// <param name="param3">This is a double parameter</param>
public static void SomeGenericMethod<T>(string param1, T param2, double param3)
{
Console.WriteLine($"The type is {typeof(T)}");
}
}
OS: Ubuntu 18.04 consulo.log
About Info
Any comments starting with and following the
<cref>
tag are not rendering. Any<param>
tags are not rendering. If there is a<typeparam>
tag, no comments are rendered.<cref> and <param> tags
:<typeparam> tag
:These are the documentation comments that I uses most often, so that is how I noticed them not rendering correctly. More of C#'s documentation comments can be found here: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments.
Does Consulo support all of C#'s documentation comments? If not, I'll open up another issue as a feature request to support the tags.
Here is the example script I used for testing: