I really like the JSDOC support, but it's compilation is not optimal when XML tags are used in the C# documentation.
An example with referencing documentation:
public class Menu
{
/// <summary>
/// The dessert recommendations grouped by <see cref="Coffee"/>.
/// </summary>
public IDictionary<Coffee, string> DessertRecommendations { get; }
}
public enum Coffee
{
Black = 1,
Americano = 2
}
This is currently serialized to this:
export interface IMenu {
/** The dessert recommendations grouped by <see cref="T:Coffee" />. */
dessertRecommendations: { [key in Coffee]: string }
}
export enum Coffee {
...
}
A better serialization would be something like this:
export interface IMenu {
/** The dessert recommendations grouped by {@link Coffee}. */
dessertRecommendations: { [key in Coffee]: string }
}
export enum Coffee {
...
}
If JSDoc annotations is unwanted, a simpler but more readable version would be to just remove the XML tags:
export interface IMenu {
/** The dessert recommendations grouped by Coffee. */
dessertRecommendations: { [key in Coffee]: string }
}
I really like the JSDOC support, but it's compilation is not optimal when XML tags are used in the C# documentation.
An example with referencing documentation:
This is currently serialized to this:
A better serialization would be something like this:
If JSDoc annotations is unwanted, a simpler but more readable version would be to just remove the XML tags: