Add space after /// when continuing doc comment (#1703)

* Add space after `///` when continuing doc comment

When continuing a document comment the next line wouldn't insert the
`/// ` automatically. When splitting an existing doc comment line the
new line would be `///` instead of `/// ` (note the space).

Issue: #1702

Author: plemarquand

CHANGELOG.md

@@ -9,6 +9,11 @@
 - Show revision hash or local/editing keyword in project panel dependency descriptions ([#1667](https://github.com/swiftlang/vscode-swift/pull/1667))
 - Show files generated by build plugins under Target in Project Panel ([#1592](https://github.com/swiftlang/vscode-swift/pull/1592))
 
+### Fixed
+
+- Prepend `/// ` when continuing documentation comments on a new line ([#1703](https://github.com/swiftlang/vscode-swift/pull/1703))
+- Respect `files.exclude` setting values set to `false` ([#1696](https://github.com/swiftlang/vscode-swift/pull/1696))
+
 ## 2.6.2 - 2025-07-02
 
 ### Fixed

src/editor/CommentCompletion.ts

@@ -39,7 +39,7 @@ class CommentCompletion extends vscode.CompletionItem {
  * CompletionItem Provider that provides "///" on pressing return if previous line
  * contained a "///" documentation comment.
  */
-class CommentCompletionProvider implements vscode.CompletionItemProvider {
+class DocCommentCompletionProvider implements vscode.CompletionItemProvider {
     public async provideCompletionItems(
         document: vscode.TextDocument,
         position: vscode.Position
@@ -48,22 +48,35 @@ class CommentCompletionProvider implements vscode.CompletionItemProvider {
         if (position.line === 0 || isLineComment(document, position.line - 1) === false) {
             return undefined;
         }
+        await this.continueExistingDocCommentBlock(document, position);
+        return [new CommentCompletion("/// ", "///", "Documentation comment")];
+    }
+
+    private async continueExistingDocCommentBlock(
+        document: vscode.TextDocument,
+        position: vscode.Position
+    ) {
+        if (!vscode.window.activeTextEditor) {
+            return;
+        }
         // Fixes https://github.com/swiftlang/vscode-swift/issues/1648
-        const match = /^(\s*)\/\/\s(.+)/.exec(document.lineAt(position.line).text);
+        const match = /^(\s*)(\/\/)?\s?(.+)?/.exec(document.lineAt(position.line).text);
         if (match) {
-            void vscode.window.activeTextEditor?.edit(
+            await vscode.window.activeTextEditor.edit(
                 edit => {
-                    void edit.replace(
+                    edit.replace(
                         new vscode.Range(position.line, 0, position.line, match[0].length),
-                        `${match[1]}///${match[2]}`
+                        `${match[1]}/// ${match[3] ?? ""}`
                     );
                 },
                 { undoStopBefore: false, undoStopAfter: true }
             );
-            return undefined;
+            const newPosition = new vscode.Position(position.line, match[1].length + 4);
+            vscode.window.activeTextEditor.selection = new vscode.Selection(
+                newPosition,
+                newPosition
+            );
         }
-        const completion = new CommentCompletion("/// ", "///", "Documentation comment");
-        return [completion];
     }
 }
 
@@ -237,8 +250,9 @@ class FunctionDocumentationCompletionProvider implements vscode.CompletionItemPr
  */
 export class CommentCompletionProviders implements vscode.Disposable {
     functionCommentCompletion: FunctionDocumentationCompletionProvider;
+    docCommentCompletion: DocCommentCompletionProvider;
     functionCommentCompletionProvider: vscode.Disposable;
-    commentCompletionProvider: vscode.Disposable;
+    docCommentCompletionProvider: vscode.Disposable;
 
     constructor() {
         this.functionCommentCompletion = new FunctionDocumentationCompletionProvider();
@@ -247,9 +261,10 @@ export class CommentCompletionProviders implements vscode.Disposable {
             this.functionCommentCompletion,
             "/"
         );
-        this.commentCompletionProvider = vscode.languages.registerCompletionItemProvider(
+        this.docCommentCompletion = new DocCommentCompletionProvider();
+        this.docCommentCompletionProvider = vscode.languages.registerCompletionItemProvider(
             "swift",
-            new CommentCompletionProvider(),
+            this.docCommentCompletion,
             "\n"
         );
     }
@@ -265,6 +280,6 @@ export class CommentCompletionProviders implements vscode.Disposable {
 
     dispose() {
         this.functionCommentCompletionProvider.dispose();
-        this.commentCompletionProvider.dispose();
+        this.docCommentCompletionProvider.dispose();
     }
 }