dotnet/roslyn

[Request] Use SymbolDisplayFormat to display modifiers and accessibility for a class, struct, interface and delegate

Open

#28,297 opened on Jul 5, 2018

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

Repository metrics

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

Description

I would like to display class symbol similar how it is displayed on docs.microsoft.com.

For example if I have public static generic class with a constraint I would like to get:

public static class Foo<T> where T : Bar

But with current SymbolDisplayFormat I can get only:

class Foo<T> where T : Bar

There are options:

  • SymbolDisplayMemberOptions.IncludeModifiers
  • SymbolDisplayMemberOptions.IncludeAccessibility

but they are not applicable for a type declaration.

So I would propose to add a new options such as:

[Flags]
public enum SymbolDisplayTypeDeclarationOptions
{
  None = 0,
  IncludeModifiers = 1,
  IncludeAccessibility = 2
}

or extend SymbolDisplayMiscellaneousOptions.

Contributor guide

Research direction
Explore the existing SymbolDisplayFormat and SymbolDisplayMemberOptions in Roslyn. Identify where type declarations are formatted and how to introduce a new enum for type declaration options. Look at existing tests for SymbolDisplayFormat to understand patterns.
Tech stack
csharp
Domain
backendcompilers
Issue type
Feature
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.
Half day
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#Roslyn SDK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60