dotnet/roslyn

Update Quick Info and Method Info to show exception reasons

Open

#1,515 创建于 2015年3月24日

在 GitHub 查看
 (24 评论) (53 反应) (0 负责人)C# (20,414 star) (4,257 fork)batch import
Area-IDEhelp wanted

描述

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.

贡献者指南

技术栈
csharp
领域
toolingdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
C#RoslynXML documentationVS extensibility
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.