You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
publicclassMenu{/// <summary>/// The dessert recommendations grouped by <see cref="Coffee"/>./// </summary>publicIDictionary<Coffee,string>DessertRecommendations{get;}}publicenumCoffee{Black=1,Americano=2}
This is currently serialized to this:
exportinterfaceIMenu{/** The dessert recommendations grouped by <see cref="T:Coffee" />. */dessertRecommendations: {[keyinCoffee]: string}}exportenumCoffee{
...
}
A better serialization would be something like this:
exportinterfaceIMenu{/** The dessert recommendations grouped by {@link Coffee}. */dessertRecommendations: {[keyinCoffee]: string}}exportenumCoffee{
...
}
If JSDoc annotations is unwanted, a simpler but more readable version would be to just remove the XML tags:
exportinterfaceIMenu{/** The dessert recommendations grouped by Coffee. */dessertRecommendations: {[keyinCoffee]: string}}
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: