XML documentation for SMO objects should have content from the strings files
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- csharp
研究方向
首先檢查 codegen 如何產生 XML 文件，以及 SFC 屬性如何在 facet 公開屬性上定義。閱讀 issue 中參照的 Smo/LocalizableResources.strings 項目，並追蹤這些字串如何公開給 SSMS。完成的標準是有一個工具將產生的 XML 與擷取出的屬性文件合併，使 NuGet XML 包含產生屬性的項目。
由索引模型根據 Issue 內容生成。
描述
Today, properties created by codegen do not have proper documentation
Example:
the XML documentation file included in the nuget package lacks entries for these properties.
To improve the documentation, we should write a tool to merge the C#-generated XML file with content extracted from the SFC attributes on each facet's public properties. Those strings are currently only shown in the SSMS UI for policy-based management.
The strings reside in the strings file, eg:
- 主要語言
- C#
- 星號
- 143
- 分支
- 28
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
microsoft/sqlmanagementobjects 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 62/100
-
難度 3/5 1-2 天 新手友好度 72/100
-
難度 4/5 3-5 天 新手友好度 74/100
-
難度 3/5 1-2 天 新手友好度 78/100
-
難度 3/5 1-2 天 新手友好度 68/100
查看 microsoft/sqlmanagementobjects 的全部 Issue
相似的 Issue
-
untriaged
難度 1/5 1 小時以內 新手友好度 88/100
dotnet/dotnet-api-docs#13095 ·
-
area-deployment area-integrations triage:bot-seen
難度 2/5 半天 新手友好度 86/100
-
type/automation type/tech-debt
難度 2/5 1-3 小時 新手友好度 84/100
-
bug
難度 1/5 1 小時以內 新手友好度 90/100
newrelic/newrelic-dotnet-agent#3850 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 88/100
LuckyPennySoftware/AutoMapper#4660 ·