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.