Test deprecation comment on BuildItemGroup.cs #10166
Conversation
| /// <format type="text/markdown"><![CDATA[ | ||
| /// > [!CAUTION] | ||
| /// > This class has been deprecated. Please use Microsoft.Build.Evaluation.ProjectCollection and related types from the Microsoft.Build assembly instead. | ||
| /// ]]> | ||
| /// </format> |
There was a problem hiding this comment.
How does this show up in IDEs?
There was a problem hiding this comment.
I mainly ask because several years ago the F# community (including me) tried to strong-arm using markdown in triple-slash comments so that things would render more nicely in VSCode. These comments rendered wonderfully in VSCode without any additional work from the F# language services, but as you might expect VS and VSMac users had a severely degraded experience. We decided after 6 months or so of pushing that across a number of community libraries to instead work on improvements to the xml syntaxes.
There was a problem hiding this comment.
This is how it currently shows on VS 2022
There was a problem hiding this comment.
That's what I was worried about :-/ That's quite cluttered in the VS view.
Context
Sample deprecation comment to be used on public types in deprecated code