dotnet/roslyn

Diagnostic for bad type arguments in cref could be more clear

Open

#4,681 建立於 2015年8月20日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)C# (20,414 star) (4,257 fork)batch import
Area-CompilersBugConcept-Diagnostic ClarityLanguage-VBhelp wanted

描述

The diagnostics introduced to fix 1087447 are confusing and deserve improvement. Specifically, for the source code

''' <summary>
''' <see cref="C(Of Integer).f()"/>
''' </summary>
Class C(Of T)
Sub f()
End Sub
End Class

we produce

BC42309: XML comment has a tag with a 'cref' attribute 'C(Of Integer).f()' that could not be resolved.
''' <see cref="C(Of Integer).f()"/>


The error is that the type argument isn't a simple identifier.

Migrated from TFS/DevDiv 1096332

貢獻者指南

技術棧
csharp
領域
backenddeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
C# or VB knowledgeXML doc comments
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Investigate the current diagnostic for cref type arguments. Look for the method that generates the warning BC42309. The goal is to improve the error message to indicate that the type argument must be a simple identifier. Check the file where cref resolution is implemented, likely in the documentation comment handling code. Consider adding a more descriptive message or linking to documentation.