Generate Documentation Auto-Insert

src/EditorFeatures/CSharp/DocumentationComments/DocumentationCommentCommandHandler.cs

@@ -25,8 +25,10 @@ internal sealed class DocumentationCommentCommandHandler(
     IUIThreadOperationExecutor uiThreadOperationExecutor,
     ITextUndoHistoryRegistry undoHistoryRegistry,
     IEditorOperationsFactoryService editorOperationsFactoryService,
-    EditorOptionsService editorOptionsService)
-        : AbstractDocumentationCommentCommandHandler(uiThreadOperationExecutor, undoHistoryRegistry, editorOperationsFactoryService, editorOptionsService)
+    EditorOptionsService editorOptionsService,
+    CopilotGenerateDocumentationCommentManager generateDocumentationCommentManager)
+            : AbstractDocumentationCommentCommandHandler(uiThreadOperationExecutor, undoHistoryRegistry,
+                editorOperationsFactoryService, editorOptionsService, generateDocumentationCommentManager)
 {
     protected override string ExteriorTriviaText => "///";
 }

src/EditorFeatures/Core/DocumentationComments/AbstractDocumentationCommentCommandHandler.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Linq;
 using System.Threading;
+using Microsoft.CodeAnalysis.DocumentationComments;
 using Microsoft.CodeAnalysis.Editor.Shared.Extensions;
 using Microsoft.CodeAnalysis.Options;
 using Microsoft.CodeAnalysis.Shared.Extensions;
@@ -31,12 +32,14 @@ internal abstract class AbstractDocumentationCommentCommandHandler :
     private readonly ITextUndoHistoryRegistry _undoHistoryRegistry;
     private readonly IEditorOperationsFactoryService _editorOperationsFactoryService;
     private readonly EditorOptionsService _editorOptionsService;
+    private readonly CopilotGenerateDocumentationCommentManager _generateDocumentationCommentManager;
 
     protected AbstractDocumentationCommentCommandHandler(
         IUIThreadOperationExecutor uiThreadOperationExecutor,
         ITextUndoHistoryRegistry undoHistoryRegistry,
         IEditorOperationsFactoryService editorOperationsFactoryService,
-        EditorOptionsService editorOptionsService)
+        EditorOptionsService editorOptionsService,
+        CopilotGenerateDocumentationCommentManager generateDocumentationCommentManager)
     {
         Contract.ThrowIfNull(uiThreadOperationExecutor);
         Contract.ThrowIfNull(undoHistoryRegistry);
@@ -46,6 +49,7 @@ protected AbstractDocumentationCommentCommandHandler(
         _undoHistoryRegistry = undoHistoryRegistry;
         _editorOperationsFactoryService = editorOperationsFactoryService;
         _editorOptionsService = editorOptionsService;
+        _generateDocumentationCommentManager = generateDocumentationCommentManager;
     }
 
     protected abstract string ExteriorTriviaText { get; }
@@ -97,13 +101,17 @@ private bool CompleteComment(
             if (snippet != null)
             {
                 ApplySnippet(snippet, subjectBuffer, textView);
+                var oldSnapshot = subjectBuffer.CurrentSnapshot;
+                var oldCaret = textView.Caret.Position.VirtualBufferPosition;
+
                 returnValue = true;
+
+                _generateDocumentationCommentManager.TriggerDocumentationCommentProposalGeneration(document, snippet, oldSnapshot, oldCaret, textView, cancellationToken);
             }
         }
 
         return returnValue;
     }
-
     public CommandState GetCommandState(TypeCharCommandArgs args, Func<CommandState> nextHandler)
         => nextHandler();
 

src/EditorFeatures/Core/DocumentationComments/CopilotGenerateDocumentationCommentManager.cs

@@ -0,0 +1,96 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.Composition;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Copilot;
+using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
+using Microsoft.CodeAnalysis.Host.Mef;
+using Microsoft.CodeAnalysis.Shared.Extensions;
+using Microsoft.CodeAnalysis.Shared.TestHooks;
+using Microsoft.VisualStudio.Language.Suggestions;
+using Microsoft.VisualStudio.Text;
+using Microsoft.VisualStudio.Text.Editor;
+
+namespace Microsoft.CodeAnalysis.DocumentationComments
+{
+    [Export(typeof(CopilotGenerateDocumentationCommentManager))]
+    internal class CopilotGenerateDocumentationCommentManager
+    {
+        private readonly SuggestionServiceBase? _suggestionServiceBase;
+        private readonly IThreadingContext _threadingContext;
+        private readonly IAsynchronousOperationListener _asyncListener;
+
+        [ImportingConstructor]
+        [Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
+        public CopilotGenerateDocumentationCommentManager([Import(AllowDefault = true)] SuggestionServiceBase? suggestionServiceBase, IThreadingContext threadingContext,
+            IAsynchronousOperationListenerProvider listenerProvider)
+        {
+            _suggestionServiceBase = suggestionServiceBase;
+            _threadingContext = threadingContext;
+            _asyncListener = listenerProvider.GetListener(FeatureAttribute.GenerateDocumentation);
+        }
+
+        public void TriggerDocumentationCommentProposalGeneration(Document document,
+            DocumentationCommentSnippet snippet, ITextSnapshot snapshot, VirtualSnapshotPoint caret, ITextView textView, CancellationToken cancellationToken)
+        {
+            if (_suggestionServiceBase is null)
+            {
+                return;
+            }
+
+            var token = _asyncListener.BeginAsyncOperation(nameof(GenerateDocumentationCommentProposalsAsync));
+            _ = GenerateDocumentationCommentProposalsAsync(document, snippet, snapshot, caret, textView, cancellationToken).CompletesAsyncOperation(token);
+        }
+
+        private async Task GenerateDocumentationCommentProposalsAsync(Document document, DocumentationCommentSnippet snippet, ITextSnapshot snapshot, VirtualSnapshotPoint caret, ITextView textView, CancellationToken cancellationToken)
+        {
+            var generateDocumentationCommentProvider = await CreateProviderAsync(document, textView, cancellationToken).ConfigureAwait(false);
+            if (generateDocumentationCommentProvider is not null)
+            {
+                await generateDocumentationCommentProvider.GenerateDocumentationProposalAsync(snippet, snapshot, caret, cancellationToken).ConfigureAwait(false);
+            }
+        }
+
+        private async Task<CopilotGenerateDocumentationCommentProvider?> CreateProviderAsync(Document document, ITextView textView, CancellationToken cancellationToken)
+        {
+            var copilotService = await IsGenerateDocumentationAvailableAsync(document, cancellationToken).ConfigureAwait(false);
+
+            if (copilotService is null)
+            {
+                return null;
+            }
+
+            var provider = textView.Properties.GetOrCreateSingletonProperty(typeof(CopilotGenerateDocumentationCommentProvider),
+                () => new CopilotGenerateDocumentationCommentProvider(_threadingContext, copilotService));
+
+            await provider!.InitializeAsync(textView, _suggestionServiceBase!, cancellationToken).ConfigureAwait(false);
+
+            return provider;
+        }
+
+        private static async Task<ICopilotCodeAnalysisService?> IsGenerateDocumentationAvailableAsync(Document document, CancellationToken cancellationToken)
+        {
+            // Bailing out if copilot is not available or the option is not enabled.
+            if (document.GetLanguageService<ICopilotOptionsService>() is not { } copilotOptionService ||
+                !await copilotOptionService.IsGenerateDocumentationCommentOptionEnabledAsync().ConfigureAwait(false))
+            {
+                return null;
+            }
+
+            if (document.GetLanguageService<ICopilotCodeAnalysisService>() is not { } copilotService ||
+                    await copilotService.IsAvailableAsync(cancellationToken).ConfigureAwait(false) is false)
+            {
+                return null;
+            }
+
+            return copilotService;
+        }
+    }
+}