Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tommai78101 opened this issue Dec 20, 2021 · 1 comment
Assignees
Labels
dotnet-csharp/svc lang-reference/subsvc ๐Ÿ“Œ seQUESTered Identifies that an issue has been imported into Quest.

Comments

@tommai78101
Copy link

tommai78101 commented Dec 20, 2021

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

@BillWagner
Copy link
Member

Thanks for reaching out @tommai78101

This is a timely request. I'll be spending the next few months updating our "fundamentals" section. This tutorial should be added there.

Thank you.

@BillWagner BillWagner self-assigned this Feb 19, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 19, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 19, 2025
@BillWagner BillWagner added the ๐Ÿ—บ๏ธ reQUEST Triggers an issue to be imported into Quest. label Mar 4, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Mar 4, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Mar 4, 2025
@sequestor sequestor bot added ๐Ÿ“Œ seQUESTered Identifies that an issue has been imported into Quest. and removed ๐Ÿ—บ๏ธ reQUEST Triggers an issue to be imported into Quest. labels Mar 5, 2025
@BillWagner BillWagner moved this from ๐Ÿ”– Ready to Slipped in dotnet/docs March 2025 sprint project Apr 2, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Apr 2, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Apr 2, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Apr 2, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Apr 2, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label May 1, 2025
@BillWagner BillWagner moved this from ๐Ÿ”– Ready to Slipped in dotnet/docs April 2025 sprint project May 1, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label May 1, 2025
@dotnetrepoman dotnetrepoman bot added the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label May 1, 2025
@dotnet-policy-service dotnet-policy-service bot removed the ๐Ÿ—บ๏ธ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet-csharp/svc lang-reference/subsvc ๐Ÿ“Œ seQUESTered Identifies that an issue has been imported into Quest.
Projects
Status: ๐Ÿ”– Ready
Development

No branches or pull requests

4 participants