dotnet/roslyn

Incorrect xml documentation id for generic class constructor

Offen

#11.687 geöffnet am 01.06.2016

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C# (4.257 Forks)batch import
Area-CompilersBugConcept-APIhelp wanted

Repository-Metriken

Stars
 (20.414 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuchen Sie, wie GetDocumentationCommentId() generische Typparameter in Konstruktoren behandelt; überprüfen Sie die Symboldarstellungslogik für generische Typen.
Tech Stack
csharp
Domain
compilers
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70