dotnet/roslyn

Update Quick Info and Method Info to show exception reasons

Open

#1.515 geöffnet am 24. März 2015

Auf GitHub ansehen
 (24 Kommentare) (55 Reaktionen) (0 zugewiesene Personen)C# (4.257 Forks)batch import
Area-IDEhelp wanted

Repository-Metriken

Stars
 (20.414 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (256 gemergte PRs in 30 T)

Beschreibung

Currently the Quick Info and Method Info features for the C# editor show the types of exceptions potentially thrown by the method (according to the documentation), but it does not include the descriptions of the reasons why these exceptions could be thrown.

It would be very helpful if the documentation presentation were updated to include this information, so method callers are more likely to correctly consider preconditions.

Contributor Guide

Research-Richtung
Untersuche die aktuelle Implementierung von Quick Info und Method Info in der Roslyn Editor Schicht, um zu verstehen, wie Ausnahmetypen angezeigt werden, und erweitere dann den Code, um auch die Beschreibungen der Ausnahmegründe aus der XML Dokumentation abzurufen und anzuzeigen.
Tech Stack
csharp
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
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#Roslyn Editor APIs
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50