dotnet/roslyn

Should protected abstract methods in SemanticModel be private protected instead?

Open

#29,235 建立於 2018年8月12日

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

描述

I noticed that protected abstract methods on SemanticModel like GetDeclaredSymbolCore are documented in Roslyn's API reference. Since it's impossible to inherit from SemanticModel for users of the API, I think such methods should not be included in the API reference.

And I think the most reasonable way to do that is to change such methods to private protected. Do you agree?

It's possible there are more types like that in the codebase, but SemanticModel is the one where I noticed this.

貢獻者指南

技術棧
csharp
領域
apidocumentation
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
C# access modifiersRoslyn SemanticModel class
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Start by examining the SemanticModel class in the Roslyn codebase (e.g., src/Workspaces/Core/Portable/Semantics/SemanticModel.cs). Find all protected abstract methods like GetDeclaredSymbolCore. Determine if they are exposed in the API reference. If so, change their accessibility to private protected. Also search for similar patterns in other types (e.g., in SyntaxTree, Compilation) that may have the same issue. Review the Roslyn documentation guidelines to confirm that hiding such methods from the API reference is desired. There are no comments on the issue, so no prior discussion to reference.