Add new line before 'where' constraints in Quick Info

[Youssef1313]

Closes #5 (the oldest open issue 😄)

• Tests to be added.
• VB to be fixed as well.

Open question:

• I could have done this in SymbolDisplay in the compiler layer. But I'm not sure if this would be okay.

• If this is to be done in the compiler layer, it can be done in two ways:

  • Always add line break.
  • Introduce a new SymbolDisplayOptions option, for example SymbolDisplayMiscellaneousOptions.LineBreakBeforeTypeParameterConstraint (will be a new public API).

The current approach is to do the work in IDE only.

[CyrusNajmabadi]

Pics please. For simple and complex cases.

[Youssef1313]

Testing revealed that this doesn't handle named types. Named types take a different code path (AddSymbolDescription(INamedTypeSymbol symbol)). Here is how it looks like for methods:

I'll adjust the implementation and add unit tests once an approach is decided:

• Compiler layer - similar to Improve the signature display when a tuple appears many times within it. #56025
• IDE layer - similar to the current state of PR.

[DoctorKrolic]

@Youssef1313 Looking at your screenshot, I would say, that you should add some offset (\t for instance) before each where line to make it even more readable

[Youssef1313]

Thanks @DoctorKrolic
Updated it to look like this:

@CyrusNajmabadi Let me know what do you think

[sharwell]

Can you also add a test where someone has a comment like this?

/// <summary>
/// This is some text <see langword="where"/> I shouldn't have a line break.
/// </summary>

[DoctorKrolic]

@Youssef1313 Can you please revisit this PR. When a class has really many wheres it gets as ridiculous as this:

I don't know how about you, but I can barely read this mess...

[Youssef1313]

@DoctorKrolic I'm getting a little bit busy as my university exams are approaching. :(
I don't mind if you want to take this up and open a PR (feel free to cherry-pick the commit or copy the code here and continue on it, if you want)

[CyrusNajmabadi]

@Youssef1313 do you want to continue this pr?

[CyrusNajmabadi]

I'll take over this PR.

[CyrusNajmabadi]

inlined this.

[Youssef1313]

Thank you @CyrusNajmabadi. Sorry I wasn't able to continue it. Lots of stuff taking up my time :(

[CyrusNajmabadi]

Not a problem at all :)