microsoft / microsoft/sqlmanagementobjects

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

Offen
#97 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
C#
Sterne
143
Forks
28
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit zu untersuchen, wie codegen die XML-Dokumentation erzeugt und wie SFC-Attribute für öffentliche Facet-Eigenschaften definiert werden. Lies den im Issue referenzierten Eintrag in Smo/LocalizableResources.strings und verfolge, wie diese Zeichenfolgen für SSMS verfügbar gemacht werden. Als erledigt gilt die Aufgabe, wenn ein Tool das erzeugte XML mit der extrahierten Eigenschaftsdokumentation zusammenführt, sodass das NuGet XML Einträge für erzeugte Eigenschaften enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.