[Cleanup] Use named arguments in PresentationFramework #10671

ThomasGoulet73 · 2025-03-29T04:12:11Z

Contributes to #10018

Description

I replaced comments specifying an argument name with named arguments, which were introduced in C# 7. This improves readability and maintainability.

My changes are in 2 commits. The first commit is automated changes using regexes and the second commit is manual changes where the comment is outdated or formatted differently than the parameter name.

Note: The compiled IL is identical.

Customer Impact

None.

Regression

No.

Testing

Local build + validated IL.

Risk

Low to none.

Microsoft Reviewers: Open in CodeFlow

Automated changes. Contributes to dotnet#10018

Manual changes. Contributes to dotnet#10018

codecov · 2025-03-29T04:34:29Z

Codecov Report

Attention: Patch coverage is 0.11211% with 891 lines in your changes missing coverage. Please review.

Project coverage is 11.22373%. Comparing base (2a8258a) to head (e5e0cd4).

Additional details and impacted files

@@                 Coverage Diff                 @@
##                main      #10671         +/-   ##
===================================================
- Coverage   11.25210%   11.22373%   -0.02838%     
===================================================
  Files           3353        3353                 
  Lines         668062      668058          -4     
  Branches       74980       74980                 
===================================================
- Hits           75171       74981        -190     
- Misses        591642      591833        +191     
+ Partials        1249        1244          -5

Flag	Coverage Δ
Debug	`11.22373% <0.11211%> (-0.02838%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jizc · 2025-03-30T05:27:06Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/MS/Internal/Ink/EditingCoordinator.cs

@@ -91,7 +91,7 @@ internal void ActivateDynamicBehavior(EditingBehavior dynamicBehavior, InputDevi
                    //we pass true for userInitiated because we've simply consulted the InputDevice
                    //(and only StylusDevice or MouseDevice) for the current position of the device
                    InitializeCapture(inputDevice, (IStylusEditing)dynamicBehavior, 
-                        true /*userInitiated*/, false/*Don't reset the RTI*/);
+                        userInitiated: true, false/*Don't reset the RTI*/);


It appears like you missed one here, Don't reset the RTI -> resetDynamicRenderer

jizc

A few more. Some may be on purpose, but I though it best to point them out. One appears to be an error that wasn't caught because it's inside a preprocessor directive.

jizc · 2025-03-30T05:31:36Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextContainer.cs

@@ -3405,7 +3405,7 @@ private void RaiseEventForFormerFirstIMEVisibleNode(TextTreeNode node)

            // Next node was the old first node.  Its IMECharCount
            // just bumped up, report that.
-            AddChange(startEdgePosition, /* symbolCount */ 0, /* IMECharCount */ 1, PrecursorTextChangeType.ContentAdded);
+            AddChange(startEdgePosition, symbolCount: 0, /* IMECharCount */ 1, PrecursorTextChangeType.ContentAdded);


IMECharCount -> charCount

jizc · 2025-03-30T05:31:46Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextContainer.cs

@@ -3417,7 +3417,7 @@ private void RaiseEventForNewFirstIMEVisibleNode(TextTreeNode node)

            // node was the old second node.  Its IMECharCount
            // just dropped down, report that.
-            AddChange(startEdgePosition, /* symbolCount */ 0, /* IMECharCount */ 1, PrecursorTextChangeType.ContentRemoved);
+            AddChange(startEdgePosition, symbolCount: 0, /* IMECharCount */ 1, PrecursorTextChangeType.ContentRemoved);


IMECharCount -> charCount

jizc · 2025-03-30T05:33:56Z

...icrosoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextEditorDragDrop.cs

@@ -415,7 +415,7 @@ internal void TargetOnDragOver(DragEventArgs e)
                            Brush caretBrush = TextSelection.GetCaretBrush(_textEditor);

                            // Show the caret on the dropable position.
-                            _caretDragDrop.Update(/*visible:*/true, caretRectangle, caretBrush, 0.5, italic, CaretScrollMethod.None, /*wordWrappingPosition*/ double.NaN);
+                            _caretDragDrop.Update(visible: true, caretRectangle, caretBrush, 0.5, italic, CaretScrollMethod.None, /*wordWrappingPosition*/ double.NaN);


wordWrappingPosition -> scrollToOriginPosition

jizc · 2025-03-30T05:36:42Z

...crosoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextRangeEditTables.cs

@@ -1180,7 +1180,7 @@ internal static TextRange InsertRows(TextRange textRange, int rowCount)
                    {
                        // Create new cell and transfer all formatting properties to it from a source cell.
                        // All properties except for RowSpan will be transferred.
-                        AddCellCopy(newRow, currentCell, -1/*negative means at the endPosition*/, /*copyRowSpan:*/false, /*copyColumnSpan:*/true);
+                        AddCellCopy(newRow, currentCell, -1/*negative means at the endPosition*/, copyRowSpan: false, copyColumnSpan: true);


Maybe this was skipped on purpose, but if not: negative means at the endPosition -> cellInsertionIndex

jizc · 2025-03-30T05:39:25Z

...PresentationFramework/System/Windows/Documents/TextServicesDisplayAttributePropertyRanges.cs

@@ -150,7 +150,7 @@ internal override void OnEndEdit(UnsafeNativeMethods.ITfContext context,

 #if UNUSED_IME_HIGHLIGHT_LAYER
                        // Need to pass the foreground and background color of the composition
-                        _highlightLayer.Add(start, end, /*TextDecorationCollection:*/null);
+                        _highlightLayer.Add(start, end, TextDecorationCollection: null);


This appears to be an error, the parameter is textDecorations

jizc · 2025-03-30T05:41:52Z

...Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Markup/Baml2006/WpfXamlType.cs

        }

        protected override XamlMember LookupAttachableMember(string name)
        {
-            return FindMember(name, true /* isAttached */, false /* skipReadOnlyCheck doens't matter for Attached */);
+            return FindMember(name, isAttached: true, false /* skipReadOnlyCheck doens't matter for Attached */);


May have been skipped on purpose, but maybe change it to skipReadOnlyCheck: false /* doens't matter for Attached */

jizc · 2025-03-30T06:17:11Z

....Wpf/src/PresentationFramework/System/Windows/Automation/Peers/DataGridItemAutomationPeer.cs

@@ -447,7 +447,7 @@ internal List<AutomationPeer> GetCellItemPeers()

                    if (column != null)
                    {
-                        DataGridCellItemAutomationPeer peer = GetOrCreateCellItemPeer(column,/*addParentInfo*/ false );
+                        DataGridCellItemAutomationPeer peer = GetOrCreateCellItemPeer(column,addParentInfo: false);


nit: spacing

jizc

Spacing nits, feel free to ignore

jizc · 2025-03-30T06:40:41Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextPointerBase.cs

@@ -894,7 +894,7 @@ internal static Rect GetCharacterRect(ITextPointer thisPointer, LogicalDirection
                }
                else if (thisPointer.TextContainer.Parent is Visual)
                {
-                    Invariant.Assert(textView.RenderScope == thisPointer.TextContainer.Parent || ((Visual)thisPointer.TextContainer.Parent).IsAncestorOf( /*descendant:*/textView.RenderScope),
+                    Invariant.Assert(textView.RenderScope == thisPointer.TextContainer.Parent || ((Visual)thisPointer.TextContainer.Parent).IsAncestorOf( descendant: textView.RenderScope),


nit: spacing

jizc · 2025-03-30T06:40:49Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Documents/TextPointerBase.cs

@@ -903,10 +903,10 @@ internal static Rect GetCharacterRect(ITextPointer thisPointer, LogicalDirection
                    templatedParent = null;
                }

-                if (templatedParent != null && templatedParent.IsAncestorOf( /*descendant:*/textView.RenderScope))
+                if (templatedParent != null && templatedParent.IsAncestorOf( descendant: textView.RenderScope))


nit: spacing

jizc · 2025-03-30T06:41:00Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Markup/ParserContext.cs

@@ -628,7 +628,7 @@ internal bool InDeferredSection
 #if !PBTCOMPILER
        internal ParserContext ScopedCopy()
        {
-            return ScopedCopy( true /* copyNameScopeStack */ );
+            return ScopedCopy( copyNameScopeStack: true);


nit: spacing

jizc · 2025-03-30T06:41:11Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/Markup/XamlStream.cs

@@ -218,7 +218,7 @@ internal int Read(byte[] buffer, int offset, int count)
            int bufferIndex;

            byte[] readBuffer = GetBufferFromFilePosition(
-                ReadPosition,true /*reader*/,
+                ReadPosition,reader: true,


nit: spacing

jizc · 2025-03-30T06:41:31Z

src/Microsoft.DotNet.Wpf/src/PresentationFramework/System/Windows/StyleHelper.cs

@@ -4777,7 +4777,7 @@ private static void DeferActions( TriggerBase triggerBase,
                if( !deferredActions.TryGetValue(triggerContainer, out actionList) )
                {
                    actionList = new List<DeferredAction>();
-                    deferredActions.Add(/* key */triggerContainer,/* value */actionList);
+                    deferredActions.Add(key: triggerContainer,value: actionList);


nit: spacing

ThomasGoulet73 added 2 commits March 28, 2025 23:54

Cleanup: Use named arguments in PresentationFramework.

2464ae9

Automated changes. Contributes to dotnet#10018

Cleanup: Use named arguments in PresentationFramework.

e5e0cd4

Manual changes. Contributes to dotnet#10018

ThomasGoulet73 requested review from a team as code owners March 29, 2025 04:12

dotnet-policy-service bot requested review from dipeshmsft, singhashish-wpf and Kuldeep-MS March 29, 2025 04:13

dotnet-policy-service bot assigned ThomasGoulet73 Mar 29, 2025

dotnet-policy-service bot added PR metadata: Label to tag PRs, to facilitate with triage Community Contribution A label for all community Contributions labels Mar 29, 2025

jizc reviewed Mar 30, 2025

View reviewed changes

jizc suggested changes Mar 30, 2025

View reviewed changes

dotnet-policy-service bot added the 📭 waiting-author-feedback To request more information from author. label Mar 30, 2025

jizc reviewed Mar 30, 2025

View reviewed changes

h3xds1nz mentioned this pull request Apr 21, 2025

Improving DynamicResource performance (second try) #10532

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cleanup] Use named arguments in PresentationFramework #10671

[Cleanup] Use named arguments in PresentationFramework #10671

ThomasGoulet73 commented Mar 29, 2025 •

edited by dotnet-policy-service bot

Loading

codecov bot commented Mar 29, 2025 •

edited

Loading

jizc Mar 30, 2025

jizc left a comment

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025 •

edited

Loading

jizc Mar 30, 2025

jizc left a comment

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

jizc Mar 30, 2025

[Cleanup] Use named arguments in PresentationFramework #10671

Are you sure you want to change the base?

[Cleanup] Use named arguments in PresentationFramework #10671

Conversation

ThomasGoulet73 commented Mar 29, 2025 • edited by dotnet-policy-service bot Loading

Description

Customer Impact

Regression

Testing

Risk

Microsoft Reviewers: Open in CodeFlow

codecov bot commented Mar 29, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

jizc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jizc Mar 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jizc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThomasGoulet73 commented Mar 29, 2025 •

edited by dotnet-policy-service bot

Loading

codecov bot commented Mar 29, 2025 •

edited

Loading

jizc Mar 30, 2025 •

edited

Loading