add comments

dotnet · Sep 16, 2024 · 99c359f · 99c359f
1 parent cfcba06
commit 99c359f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/EditorFeatures/Core.Wpf/InlineRename/UI/SmartRename/SmartRenameViewModel.cs b/src/EditorFeatures/Core.Wpf/InlineRename/UI/SmartRename/SmartRenameViewModel.cs
@@ -92,6 +92,12 @@ public string? SelectedSuggestedName
         }
     }
 
+    /// <summary>
+    /// IsSuggestionsPanelExpanded is used to control the visibility of the suggestions panel.
+    /// SupportsAutomaticSuggestions the flag to determine whether the SmartRename will generate suggestion automatically.
+    /// When SupportsAutomaticSuggestions disenabled, the suggestions panel is supposed to always expanded once it's shown, thus users can see the suggestions.
+    /// When SupportsAutomaticSuggestions enabled, the suggestions panel is supposed to react to the smart rename button click. If the button is clicked, IsAutomaticSuggestionsEnabled will be true, the panel will be expanded, Otherwise, it will be collapsed.
+    /// </summary>
     public bool IsSuggestionsPanelExpanded => HasSuggestions && (!SupportsAutomaticSuggestions || IsAutomaticSuggestionsEnabled);
 
     public string GetSuggestionsTooltip