Add CompositeFormat class reference to composite formatting docs#53686
Merged
Conversation
… docs Agent-Logs-Url: https://github.com/dotnet/docs/sessions/dd16e561-6b82-4867-8a98-20e6d2548480 Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
… passive voice Agent-Logs-Url: https://github.com/dotnet/docs/sessions/dd16e561-6b82-4867-8a98-20e6d2548480 Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to mention CompositeFormat class
Add CompositeFormat class reference to composite formatting docs
May 12, 2026
adegeo
reviewed
May 14, 2026
Agent-Logs-Url: https://github.com/dotnet/docs/sessions/852f2c56-67d5-4a3b-9dbc-de2fce785e97 Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
adegeo
reviewed
May 14, 2026
Agent-Logs-Url: https://github.com/dotnet/docs/sessions/d2b72e2c-024c-45f4-80d1-98115f932ec2 Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the composite formatting documentation to introduce System.Text.CompositeFormat (available starting in .NET 8) as a performance optimization when you reuse the same composite format string.
Changes:
- Add a new “Improve performance with CompositeFormat” section to the composite formatting article, including CA1863 guidance and a
CompositeFormatAPI reference. - Add C# and Visual Basic snippet regions demonstrating
CompositeFormat.Parse(...)and formatting with the cached format. - Wire the new snippet regions into the existing snippet runners by invoking
CompositeFormatDemo().
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/standard/base-types/snippets/composite-formatting/net/vb/Program.vb | Adds a VB CompositeFormatDemo snippet region and calls it from Main. |
| docs/standard/base-types/snippets/composite-formatting/net/csharp/Program.cs | Adds a C# CompositeFormatDemo snippet region and calls it from the top-level driver. |
| docs/standard/base-types/composite-formatting.md | Adds a new performance section for CompositeFormat, links the new snippets, and adds CompositeFormat to See also. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
adegeo
approved these changes
May 14, 2026
auto-merge
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.
CompositeFormatDemoC# snippet showingCompositeFormatusage to the existing snippet fileCompositeFormatDemoVB snippet showingCompositeFormatusage to the existing snippet filecomposite-formatting.mdCompositeFormatAPI linkImports Systemin VB file, improve code comments, fix passive voiceInternal previews