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 ·