microsoft / microsoft/sqlmanagementobjects

XML documentation for SMO objects should have content from the strings files

未关闭
#97 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
C#
星标
143
派生
28
PR 合并指标
30 天内没有已合并 PR

描述

Today, properties created by codegen do not have proper documentation
Example:

https://docs.microsoft.com/dotnet/api/microsoft.sqlserver.management.smo.database.azureedition?view=sql-smo-160

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:

https://github.com/microsoft/sqlmanagementobjects/blob/f68bac8d8f651ab5415ef53b81c817677e668c28/src/Microsoft/SqlServer/Management/Smo/LocalizableResources.strings#L657

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查 codegen 如何生成 XML 文档,以及 SFC 属性如何在 facet 公共属性上定义。阅读 issue 中引用的 Smo/LocalizableResources.strings 条目,并追踪这些字符串如何暴露给 SSMS。完成的标准是有一个工具将生成的 XML 与提取出的属性文档合并,使 NuGet XML 包含生成属性的条目。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。