Skip to content

Conversation

@BillWagner
Copy link
Member

@BillWagner BillWagner commented Jan 16, 2026

Contributes to #50891

Commit by commit:

  1. C# Guide root folder
  2. XMLDocs folder
  3. Statements folder
  4. build warnings
  5. Copilot feedback

Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/csharp/language-reference/configure-language-version.md Configure C# language version
docs/csharp/language-reference/language-versioning.md Language versioning
docs/csharp/language-reference/preprocessor-directives.md C# preprocessor directives
docs/csharp/language-reference/statements/checked-and-unchecked.md docs/csharp/language-reference/statements/checked-and-unchecked
docs/csharp/language-reference/statements/declarations.md Declaration statements
docs/csharp/language-reference/statements/exception-handling-statements.md Exception-handling statements - throw, try-catch, try-finally, and try-catch-finally
docs/csharp/language-reference/statements/fixed.md "fixed statement - pin a moveable variable"
docs/csharp/language-reference/statements/iteration-statements.md Iteration statements - for, foreach, do, and while
docs/csharp/language-reference/statements/jump-statements.md docs/csharp/language-reference/statements/jump-statements
docs/csharp/language-reference/statements/lock.md The lock statement - ensure exclusive access to a shared resource
docs/csharp/language-reference/statements/selection-statements.md Selection statements - if, if-else, and switch
docs/csharp/language-reference/statements/using.md "using statement - ensure the correct use of disposable objects"
docs/csharp/language-reference/statements/yield.md yield statement - provide the next element
docs/csharp/language-reference/unsafe-code.md Unsafe code, pointer types, and function pointers
docs/csharp/language-reference/xmldoc/examples.md docs/csharp/language-reference/xmldoc/examples
docs/csharp/language-reference/xmldoc/index.md Generate XML API documentation comments
docs/csharp/language-reference/xmldoc/recommended-tags.md Recommended XML tags for C# documentation comments

Contributes to dotnet#50891

Commit by commit:

- C# Guide root.
Add the new include file, perform a general edit and freshness pass.
@BillWagner BillWagner force-pushed the more-initial-version branch from 1bafb86 to 27227c6 Compare January 16, 2026 18:39
Add the include file in all files in the Statements folder. Perform a general edit and freshness pass.
@BillWagner BillWagner marked this pull request as ready for review January 16, 2026 21:17
@BillWagner BillWagner requested a review from a team as a code owner January 16, 2026 21:17
Copilot AI review requested due to automatic review settings January 16, 2026 21:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR continues the work of adding version include notes to C# documentation files. The changes focus on two main areas: the C# Guide root folder and the XMLDocs folder. The PR adds the [!INCLUDE[csharp-version-note](../includes/initial-version.md)] directive to all modified files and makes numerous style improvements to align with the Microsoft documentation guidelines.

Changes:

  • Added version include notes to 17 C# language reference documentation files
  • Updated dates across all files to reflect current or near-current dates
  • Improved writing style throughout to use active voice, imperative mood, and second person ("you")
  • Enhanced clarity and readability by converting passive constructions to active ones

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
recommended-tags.md Added version note; improved style with active voice and imperative mood throughout XML tag documentation
index.md Added version note; enhanced clarity in XML documentation comments overview
examples.md Added version note; refined language for XML documentation examples
unsafe-code.md Added version note; improved explanations of unsafe code, pointers, and function pointers
yield.md Added version note; clarified yield statement usage in iterators
using.md Added version note; improved using statement documentation
selection-statements.md Added version note; enhanced if/switch statement explanations
lock.md Added version note; clarified lock statement behavior
jump-statements.md Added version note; improved jump statement documentation
iteration-statements.md Added version note; refined iteration statement explanations
fixed.md Added version note; clarified fixed statement usage
exception-handling-statements.md Added version note; improved exception handling documentation
declarations.md Added version note; enhanced declaration statement explanations
checked-and-unchecked.md Added version note; clarified overflow-checking context
preprocessor-directives.md Added version note; improved preprocessor directive documentation with one critical error
language-versioning.md Added version note; updated Visual Studio compatibility reference
configure-language-version.md Added version note; refined language version configuration guidance

@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Jan 16, 2026
@BillWagner BillWagner closed this Jan 16, 2026
@BillWagner BillWagner reopened this Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

advanced-concepts/subsvc dotnet-csharp/svc lang-reference/subsvc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants