Describe the issue or suggestion
On the page Recommended XML tags for C# documentation comments, an example of using the exception tag with a description is shown.
<exception cref="member">description</exception>
But I don't think it's supported to include a description for an exception by placing content within the tag's child content. I have tested in Visual Studio and in Visual Studio Code with the C# Dev Kit where placing content within the exception tags makes no difference in either IDE.
Should we remove the description part of the example? The description is not mentioned in any of the surrounding text, so it would be a small change. I can make a PR if you agree.
<exception cref="member" />
Document Details
⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.
Describe the issue or suggestion
On the page Recommended XML tags for C# documentation comments, an example of using the
exceptiontag with a description is shown.But I don't think it's supported to include a description for an exception by placing content within the tag's child content. I have tested in Visual Studio and in Visual Studio Code with the C# Dev Kit where placing content within the
exceptiontags makes no difference in either IDE.Should we remove the description part of the example? The description is not mentioned in any of the surrounding text, so it would be a small change. I can make a PR if you agree.
Document Details
⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.