dotnet/roslyn

Pasting generic type names in doc comments should escape '<' and '>'

Open

#19,197 建立於 2017年5月3日

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

描述

I find myself often passing type names into <see cref=""/> constructs, it would be so helpful if the '<' and `>' would be automatically replaced with '{' and '}'.

貢獻者指南

技術棧
csharp
領域
documentationdeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
C# experienceDoc comment syntaxRoslyn compiler internals
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
The issue involves modifying the code that handles pasting type names into doc comment <see cref> constructs. Look at the code in the Roslyn repository that processes documentation comments, possibly in `src/Compilers/CSharp/Portable/Syntax/DocumentationCommentSyntax.cs` or related files. The goal is to automatically escape '<' and '>' with '{' and '}' when pasting. Consider adding a transformation in the paste handler or in the doc comment generator. No linked PRs or comments provide further guidance.