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# (20,414 stars) (4,257 forks)batch import
Area-CompilersBugConcept-APIhelp wanted

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

Tech stack
csharp
Domain
developer experiencetooling
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#Roslyn compiler basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the method GetDocumentationCommentId in the Roslyn symbol model, likely found in the Symbol or DocumentationCommentId classes. The issue is that for generic class constructors, it returns the instantiated type (e.g., {System.Int32}) instead of the generic form (`1). Look at the implementation to see how the XML ID is constructed and where the type parameters are substituted. Check if there are existing tests for this behavior and consider adding a fix that preserves the generic parameter placeholder.