microsoft / microsoft/sqlmanagementobjects
XML documentation for SMO objects should have content from the strings files
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 143
- Fork
- 28
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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:
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando come codegen produca la documentazione XML e come vengano definiti gli attributi SFC sulle proprietà pubbliche dei facet. Leggi la voce di Smo/LocalizableResources.strings a cui si fa riferimento nell’issue e traccia il modo in cui queste stringhe vengono esposte a SSMS. Il lavoro è completato quando uno strumento unisce l’XML generato alla documentazione estratta delle proprietà, in modo che l’XML NuGet contenga voci per le proprietà generate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100