Skip to content

XML-style Documentation comments have inconsistent newline behavior #8025

Closed
microsoft/vscode
#242121
@Skyedra

Description

@Skyedra

Issue Description

Since upgrading to C# extension v2, I have noticed the documentation comments are not behaving as expected.

Expected Behavior

When inside a documentation comment, pressing enter should produce three slashes on the next line.

Actual Behavior

This DOES work at the end of a line, but does NOT work mid-line.

Steps to Reproduce

  1. Create a new comment with three slashes
  2. Make multiple lines of lorem ipsum text
  3. Go back and edit one of your lines to put a newline in the middle of it
  4. Stealthily you now have one of your comment lines have two slashes instead of three
newline.mp4

Logs

(Seems to be intended behavior / didn't see any relevant logs produced)

Environment information

VSCode version: 1.97.2
C# Extension: 2.63.32
Using OmniSharp: false

Dotnet Information .NET SDK: Version: 8.0.112 Commit: 3f0c4a16e5 Workload version: 8.0.100-manifests.784cc8f7

Runtime Environment:
OS Name: ubuntu
OS Version: 24.04
OS Platform: Linux
RID: ubuntu.24.04-x64
Base Path: /usr/lib/dotnet/sdk/8.0.112/

.NET workloads installed:
Workload version: 8.0.100-manifests.784cc8f7
There are no installed workloads to display.

Host:
Version: 8.0.12
Architecture: x64
Commit: 89ef51c5d8

.NET SDKs installed:
6.0.136 [/usr/lib/dotnet/sdk]
8.0.112 [/usr/lib/dotnet/sdk]

.NET runtimes installed:
Microsoft.AspNetCore.App 6.0.36 [/usr/lib/dotnet/shared/Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 8.0.12 [/usr/lib/dotnet/shared/Microsoft.AspNetCore.App]
Microsoft.NETCore.App 6.0.36 [/usr/lib/dotnet/shared/Microsoft.NETCore.App]
Microsoft.NETCore.App 8.0.12 [/usr/lib/dotnet/shared/Microsoft.NETCore.App]

Other architectures found:
None

Environment variables:
Not set

global.json file:
Not found

Learn more:
https://aka.ms/dotnet/info

Download .NET:
https://aka.ms/dotnet/download

Visual Studio Code Extensions
Extension Author Version Folder Name
codedox wiggin77 1.3.3 wiggin77.codedox-1.3.3
csharp ms-dotnettools 2.63.32 ms-dotnettools.csharp-2.63.32-linux-x64
haxe-debug vshaxe 1.2.3 vshaxe.haxe-debug-1.2.3
haxe-extension-pack vshaxe 1.3.0 vshaxe.haxe-extension-pack-1.3.0
haxe-hl HaxeFoundation 1.4.27 haxefoundation.haxe-hl-1.4.27
hxcpp-debugger vshaxe 1.2.4 vshaxe.hxcpp-debugger-1.2.4
svn-scm johnstoncode 2.17.0 johnstoncode.svn-scm-2.17.0
vscode-docker ms-azuretools 1.29.4 ms-azuretools.vscode-docker-1.29.4
vscode-dotnet-runtime ms-dotnettools 2.2.8 ms-dotnettools.vscode-dotnet-runtime-2.2.8
vscode-firefox-debug firefox-devtools 2.14.1 firefox-devtools.vscode-firefox-debug-2.14.1
vscode-glimmer-syntax lifeart 1.0.35 lifeart.vscode-glimmer-syntax-1.0.35
vscode-intelephense-client bmewburn 1.12.6 bmewburn.vscode-intelephense-client-1.12.6
vscode-proto3 zxh404 0.5.5 zxh404.vscode-proto3-0.5.5
vshaxe nadako 2.34.1 nadako.vshaxe-2.34.1
xml DotJoshJohnson 2.5.1 dotjoshjohnson.xml-2.5.1

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions