dotnet / roslyn

The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
https://docs.microsoft.com/dotnet/csharp/roslyn-sdk/
MIT License
18.74k stars 3.99k forks source link

Recognize backquotes and triple-backquotes in xml docs #25867

Open jcouv opened 6 years ago

jcouv commented 6 years ago

image

Relates to https://github.com/dotnet/roslyn/pull/23984/files#r178449741

CyrusNajmabadi commented 6 years ago

This would be nice to have :) Look at the DocumentationComment type for where the IDE takes the xml text and processes it.

sharwell commented 6 years ago

This needs to go to a design meeting. I have an objection to merging/shipping an implementation prior to design approval and adoption in the language specification.

sharwell commented 6 years ago

See dotnet/csharplang#891 for the language design issue.

svick commented 6 years ago

I agree that supporting Markdown (and possibly also some simple syntax for XML elements that don't have counterparts in Markdown) is a great idea. But it should be done all at once in a systematic manner, not "add backquotes, then some other syntax, then another, and end up with complex, undocumented mess".

sharwell commented 6 years ago

During a design meeting today, we determined that this feature can't really move forward until at minimum one of the following occurs:

The implementation of the second item does not guarantee that the feature will be implemented without support from the language specification; should that situation arise will again consider the available design proposals to decide if the issue should remain blocked.