Expand C# documentation best practices#273
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR expands the C# documentation best practices by reorganizing and adding comprehensive guidelines from the official .NET documentation standards. The update transforms a basic list of XML comment tags into a structured guide with specific sections for different API types.
Key changes:
- Reorganized content into logical sections (Methods, Constructors, Properties, Exceptions)
- Added detailed guidance for parameter descriptions, return values, and property documentation
- Expanded exception documentation guidelines with specific formatting requirements
gewarren
commented
Sep 30, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
aaronpowell
approved these changes
Oct 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
Updated the documentation guidelines based on https://github.com/dotnet/dotnet-api-docs/wiki.
Type of Contribution
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.