dotnet/roslyn

Argument wrapping fails in the precense of comments

Open

#40,368 opened on Dec 13, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-IDEBugIDE-CodeStylehelp wanted

Repository metrics

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

Description

Consider this code:

public void M(object param1, object param2)
{
	M(
		1,
		// Comment
		2);
}

We do not show any help for adjusting how the comments are wrapped in this case. While I understand not being able to unwrap comments here (where are we supposed to put the comment, after all), changing the indentation level of the arguments should be possible. /cc @CyrusNajmabadi for thoughts on how this could be improved.

Contributor guide

Research direction
Examine the argument wrapping logic in the Roslyn formatting engine to understand how comments affect the indentation and wrapping of arguments. Look for tests related to argument wrapping with comments and trace the code path for formatting method arguments.
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-3 hours
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.
75