dotnet/roslyn

Incorrect xml documentation id for generic class constructor

Open

#11,687 opened on Jun 1, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-CompilersBugConcept-APIhelp wanted

Repository metrics

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

Description

Version Used: 1.1.1

Steps to Reproduce:

  1. Create a generic class with one or more type parameters:
    public class Class1<T>
    {
        public Class1()
        {
            Console.WriteLine("Class1"); 
        }
    }
  1. When we instantiate the class using code such as var x = new Class1<int>(), and get the symbol when cursor is at the Class1, then get the xml documentation id by calling symbol.GetDocumentationCommentId(), it will contain the actual data type System.Int32, which is incorrect.

Expected Behavior:

It should return something like this:

M:XmlDocIdTest.Class1`1.#ctor

Actual Behavior:

M:XmlDocIdTest.Class1{System.Int32}.#ctor

Contributor guide

Research direction
Examine how GetDocumentationCommentId() handles generic type parameters in constructors; look at the symbol display logic for generic types.
Tech stack
csharp
Domain
compilers
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