Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte
#97 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
csharp
Domaine
documentation

Piste de recherche

Commencez par examiner comment codegen produit la documentation XML et comment les attributs SFC sont définis sur les propriétés publiques des facets. Lisez l’entrée Smo/LocalizableResources.strings référencée dans l’issue et suivez la manière dont ces chaînes sont exposées à SSMS. Le travail est terminé lorsqu’un outil fusionne le XML généré avec la documentation extraite des propriétés afin que le XML NuGet contienne des entrées pour les propriétés générées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
C#
Étoiles
143
Forks
28
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de microsoft/sqlmanagementobjects

Toutes les issues de microsoft/sqlmanagementobjects

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.