dotnet/roslyn

Add code snippets to syntax api docstrings

Aperta

#54.631 aperta il 6 lug 2021

Vedi su GitHubGuida contributor
 (1 commento) (1 reazione) (0 assegnatari)C# (4257 fork)batch import
Area-CompilersConcept-APIFeature Requesthelp wanted

Metriche repository

Star
 (20.414 stelle)
Metriche merge PR
 (Merge medio 6g 17h) (256 PR mergiate in 30 g)

Descrizione

Background and Motivation

When I navigate the syntax api with my IDE it is not eaasy to figure out what each SyntaxNode implementation class is representing practially.

Proposed API

Change the docsstrings of Syntax classes to include examples (code snippets of chsarp code showcasing the syntax). These can be long docstrings covering differrent cases and mentioning common misunderstandings and references to other classes / docstrings.

In case there is awesome documentation online that you have in mind. That is great then the docstrings can just include the link for that.

Guida contributor

Direzione di ricerca
Identifica una sottoclasse di SyntaxNode, esamina la sua docstring e aggiungi uno snippet di codice che mostri la sintassi che rappresenta. Esegui i test per assicurarti che non ci siano errori di compilazione.
Tech stack
csharp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75