dotnet/roslyn

VS2017: Undesired reformatting when uncommenting a section

Open

#29,647 opened on Sep 3, 2018

View on GitHub
 (9 comments) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-IDEDeveloper CommunityIDE-Formatterhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

I'm working in C# and I have a line of code like this:

foo( a, b );

I decide to comment it, using the toolbar button or CTRL-K, CTRL-C. It becomes:

//foo( a, b );

Then I want to revert the operation, using the opposite function. VisualStudio decides that removing the comment marker is not enough, and the line becomes:

foo(a, b);

Please do NOT reformat my code without my consent, ever!

This issue has been moved from https://developercommunity.visualstudio.com/content/problem/324827/vs2017-undesired-reformatting-when-uncommenting-a.html VSTS ticketId: 674251 These are the original issue comments: (no comments) These are the original issue solutions:

Jinu Joseph [MSFT] solved on 9/3/2018, 04:16 AM (4 hours ago), 0 votes: Thank you for your feedback! This issue appears to be identical to https://github.com/dotnet/roslyn/issues/29482 We recommend that you vote on and follow the earlier reported issue for updates and fix notifications.

Contributor guide

Research direction
Examine the formatting logic in Roslyn that triggers on uncommenting, specifically the linked issue #29482. Trace how the IDE handler invokes formatting and understand the conflict between comment removal and formatting rules.
Tech stack
csharp
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40