Diagnostic for bad type arguments in cref could be more clear

説明

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

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

Issue 種別

feature

難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。

3

推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。

1-2 days

活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。

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.