dotnet/roslyn

Update Quick Info and Method Info to show exception reasons

Open

#1,515 opened on Mar 24, 2015

View on GitHub
 (24 comments) (53 reactions) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-IDEhelp wanted

Description

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

Tech stack
csharp
Domain
toolingdeveloper experience
Issue type
feature
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.
1-2 days
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#RoslynXML documentationVS extensibility
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Study the Quick Info and Method Info implementations in the Roslyn EditorFeatures project, likely under src/EditorFeatures/CSharp. Determine how exception types are currently presented and where to integrate the reason descriptions. Review XML documentation comment parsing to extract the reason strings from <exception> elements. Check the issue comments for prior discussion on design decisions.