dotnet/roslyn

Add code snippets to syntax api docstrings

Offen

#54.631 geöffnet am 06.07.2021

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)C# (4.257 Forks)batch import
Area-CompilersConcept-APIFeature Requesthelp wanted

Repository-Metriken

Stars
 (20.414 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (256 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifiziere eine SyntaxNode Unterklasse, untersuche ihren Docstring und füge ein Code Snippet hinzu, das die dargestellte Syntax demonstriert. Führe Tests aus, um sicherzustellen, dass keine Build Fehler auftreten.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75