XML documentation for SMO objects should have content from the strings files
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- csharp
- Bereich
- documentation
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.
Beschreibung
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:
- Vorherrschende Sprache
- C#
- Sterne
- 143
- Forks
- 28
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoft/sqlmanagementobjects
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 74/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 78/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
Alle Issues in microsoft/sqlmanagementobjects
Ähnliche Issues
-
untriaged
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
dotnet/dotnet-api-docs#13095 ·
-
area-deployment area-integrations triage:bot-seen
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 86/100
-
type/automation type/tech-debt
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
-
bug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
newrelic/newrelic-dotnet-agent#3850 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
LuckyPennySoftware/AutoMapper#4660 ·