Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
#97 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
csharp
Domínio
documentation

Direção de pesquisa

Comece examinando como codegen produz a documentação XML e como os atributos SFC são definidos nas propriedades públicas dos facets. Leia a entrada de Smo/LocalizableResources.strings referenciada no issue e acompanhe como essas strings são expostas ao SSMS. Considera-se concluído quando uma ferramenta mescla o XML gerado com a documentação extraída das propriedades, de modo que o XML do NuGet contenha entradas para as propriedades geradas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
C#
Estrelas
143
Forks
28
Nenhum PR com merge em 30d

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de microsoft/sqlmanagementobjects

Todas as issues de microsoft/sqlmanagementobjects

Issues semelhantes

Mais issues de C#

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.