dotnet/roslyn

`DocumentationCommentId` doesn't handle keyword-like identifiers with `@`

Open

#55,527 opened on Aug 10, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-CompilersConcept-Continuous Improvementhelp wanted

Repository metrics

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

Description

namespace MyApp
{
    public class @new { }
}

DocumentationCommentId.CreateReferenceId should return MyApp.@new instead of MyApp.new

Contributor guide

Research direction
Inspect the `DocumentationCommentId.CreateReferenceId` method and modify its logic to prepend `@` when the identifier is a C# keyword.
Tech stack
csharp
Domain
apibackend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
70