Triple slash doc updates #202
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the C# documentation prompt file to expand and improve the guidelines for writing XML documentation comments, aligning with Microsoft's documentation standards. The changes provide more comprehensive guidance on using various XML documentation tags effectively.
Key Changes
- Added guidance for referencing parameters and type parameters in documentation text
- Clarified the distinction between
<see cref>for inline references and<seealso>for standalone references - Enhanced code block documentation with language attribute requirements
| - Use `<returns>` for method return values. | ||
| - Use `<remarks>` for additional information, which can include implementation details, usage notes, or any other relevant context. | ||
| - Use `<example>` for usage examples on how to use the member. | ||
| - Use `<exception>` to document exceptions thrown by methods. | ||
| - Use `<see>` and `<seealso>` for references to other types or members. | ||
| - Use `<see langword>` for language-specific keywords like `null`, `true`, `false`, `int`, `bool`, etc. |
There was a problem hiding this comment.
This line duplicates the guidance already provided on line 27. Consider removing this duplicate or consolidating the guidance into a single location to avoid redundancy.
Copilot uses AI. Check for mistakes.
aaronpowell
approved these changes
Aug 21, 2025
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
Expanded documentation prompts based on https://learn.microsoft.com/en-us/help/contribute-ref/how-to-write-net-docs.
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.