-
Notifications
You must be signed in to change notification settings - Fork 6k
Description
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" ?
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
- ID: 5b320175-c9fe-d92e-748a-8cd511e7c12d
- Version Independent ID: 707b352c-ea51-494c-d4f1-33e140ab9d17
- Content: XML documentation comments - document APIs using /// comments
- Content Source: docs/csharp/language-reference/xmldoc/index.md
- Product: dotnet-csharp
- Technology: csharp-language-reference
- GitHub Login: @BillWagner
- Microsoft Alias: wiwagn
Metadata
Metadata
Assignees
Labels
Type
Projects
Status