Skip to content

Requesting for "XML documentation comments" page to be added to the C# Tutorials page. #27639

@tommai78101

Description

@tommai78101

When a new user (like me) visits the C# Documentation page and wants to learn about how to properly write C# documentation comments in the source codes, I would expect myself to be able to see a tutorial guide on how to write them on the C# Guide home page here:

https://docs.microsoft.com/en-us/dotnet/csharp/

However, instead of being able to see this documentation, I had to resort to asking someone else who is more familiar with C# than I am to find the article on how to write documentation comments. The article in question, "XML Documentation Comments", is nested pretty deep in "Language Reference" in the C# Guide, so I, a newbie to C#, wouldn't even realize there's such an article in that section.

May I request to have a direct link to the "XML documentation comments" on the C# Guide home page?

https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/

Thanks in advance.

I guess we can add the "XML documentation comments" under "What's New" > "Tutorials" ?

image


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 402705

Metadata

Metadata

Assignees

Type

No type

Projects

Status

🔖 Ready

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions