samples

.NET -Samples

Dieses Repo enthält den gesamten Beispielcode, der Teil eines beliebigen Themas unter der .NET -Dokumentation ist. Es gibt verschiedene Projekte, die in Unterordnern organisiert sind. Diese Unterordner sind ähnlich wie die Organisation der Dokumente für .NET organisiert. Einige der Artikel haben mehr als eine mit ihnen verbundene Probe.

Das Content-Team verfolgt Probleme für die .NET-Dokumentation in den DOTNE/DOCS und DOTNET/DOTNET-API-DOCS-Repositories. In diesem Repository werden Probleme ausgeschaltet. Dateiprobleme gegen vorhandene Beispiele und Vorschläge für neue Stichproben in diesen Repositorys. Wenn Sie nicht sicher sind, wo, wählen Sie Dotnet/Docs. Dieser Prozess hält die mit den Artikeln verbundenen Themen, die die Konzepte für jede Probe erklären. Der beste Prozess besteht darin, ein Problem aus der Feedback -Steuerung am Ende der Seite der Dokumente einzureichen:

• Für vorhandene Beispiele stellen Sie das Problem auf der Seite mit dem Beispiel ein.
• Um neue Beispiele vorzuschlagen, stellen Sie das Problem auf der Indexseite ein, auf der Sie das neue Beispiel sehen möchten.

Der Code in diesem Repository repräsentiert Programme, die Anwendungs- oder Bibliotheksszenarien demonstrieren. Diese Proben verwenden häufig mehr als eine Technologie, Funktion oder Toolkit. Jedes Beispiel verfügt über eine readme.md -Datei, in der das Beispiel erläutert wird, und Links zu Ressourcen für weitere Informationen.

Beispiele sollten erbaubare Projekte sein. Diese Projekte sollten auf den breitesten Plattformen für die angegebene Stichprobe erstellen und ausgeführt werden. In der Praxis bedeutet dies, nach Möglichkeit .NET Core-basierte Konsolenanwendungen zu erstellen. Muster, die spezifisch für das Web- oder ein UI -Framework sind, sollten diese Tools nach Bedarf hinzufügen. Beispiele sind Webanwendungen, mobile Apps, WPF- oder Windows -Formulare -Apps usw.

Wir arbeiten daran, ein CI -System für alle Code vorhanden zu haben. Wenn Sie Updates für Beispiele erstellen, stellen Sie sicher, dass jedes Update Teil eines erbaubaren Projekts ist. Fügen Sie im Idealfall auch Tests zur Korrektheit von Proben hinzu.

Eine Probe bauen

Erstellen Sie ein beliebiges .NET -Core -Beispiel mit der mit dem .NET Core SDK installierten .NET -Core -CLI. Führen Sie dann diese Befehle aus der CLI im Verzeichnis eines beliebigen Beispiels aus:

 dotnet build
dotnet run

Diese werden alle erforderlichen Abhängigkeiten installieren, das Projekt erstellen und das Projekt betreiben.

Multi-Project-Beispiele haben Anweisungen in ihrem Root-Verzeichnis in einer README.md Datei.

Sofern nicht notiert, erstellen alle Proben aus der Befehlszeile auf einer von .NET Core unterstützten Plattform. Es gibt einige Muster, die spezifisch für Visual Studio sind und Visual Studio 2017 oder höher erfordern. Darüber hinaus zeigen einige Muster plattformspezifische Funktionen und benötigen eine bestimmte Plattform. Andere Samples und Snippets benötigen das .NET -Framework und werden auf Windows -Plattformen ausgeführt und benötigt das Entwicklerpaket für die Target -Framework -Version.

Neue Samples erstellen

Wenn Sie ein Code -Beispiel hinzufügen möchten:

1. Ihr Beispiel muss Teil eines baubaren Projekts sein . Nach Möglichkeit sollten die Projekte auf allen von .NET Core unterstützten Plattformen aufbauen. Ausnahmen davon sind Muster, die ein plattformspezifisches Feature oder ein plattformspezifisches Tool demonstrieren.

2. Ihre Probe sollte dem Laufzeit -Codierungsstil entsprechen, um die Konsistenz aufrechtzuerhalten.

   • Darüber hinaus bevorzugen wir die Verwendung static Methoden anstelle von Instanzmethoden, wenn wir etwas demonstrieren, das kein neues Objekt instanziiert.

3. Ihr Beispiel sollte eine entsprechende Ausnahmebehandlung enthalten. Es sollte alle Ausnahmen behandeln, die wahrscheinlich in den Kontext der Stichprobe geworfen werden. Beispielsweise sollte eine Probe, die die Konsole -Readline -Methode zum Abrufen der Benutzereingabe aufruft, eine entsprechende Ausnahmebehandlung verwenden, wenn die Eingabezeichenfolge als Argument an eine Methode übergeben wird. In ähnlicher Weise muss die daraus resultierende Ausnahme behandelt werden, wenn Ihre Probe erwartet, dass ein Methodenaufruf fehlschlägt. Gehen Sie immer mit den spezifischen Ausnahmen ab, die von der Methode stattfinden, anstatt Ausnahmen der Basisklassen wie Ausnahme oder SystemException.

4. Wenn Ihr Beispiel ein eigenständiges Paket erstellt, müssen Sie die von unserem CI -Build -System verwendeten Laufzeiten zusätzlich zu den von Ihrem Beispiel verwendeten Laufzeiten enthalten:

   • win7-x64
   • win8-x64
   • win81-x64
   • ubuntu.16.04-x64

Wir werden in Kürze ein CI -System vorhanden sein, um diese Projekte zu erstellen.

Um ein Beispiel zu erstellen:

1. Stellen Sie ein Problem ein oder fügen Sie einen Kommentar zu einem vorhandenen hinzu, an dem Sie daran arbeiten.

2. Schreiben Sie das Thema, das die in Ihrem Beispiel gezeigten Konzepte erläutert (Beispiel: docs/standard/linq/where-clause.md ).

3. Schreiben Sie Ihr Beispiel (Beispiel: während der Stichprobe1.cs ).

4. Erstellen Sie ein Programm . Wenn es bereits einen dort gibt, fügen Sie den Anruf zu Ihrem Beispiel hinzu:

    public class Program
   {
       public void Main ( string [ ] args )
       {
           WhereClause1 . QuerySyntaxExample ( ) ;
   
           // Add the method syntax as an example.
           WhereClause1 . MethodSyntaxExample ( ) ;
       }
   }

5. Schauen Sie sich die Lösungsdatei nicht an, wenn sie nur ein Projekt enthält.

Um Ihre Probe zu bauen und auszuführen:

1. Gehen Sie zum Beispielordner und erstellen Sie, um auf Fehler zu suchen:

    dotnet build

2. Führen Sie Ihr Beispiel aus:

    dotnet run

3. Fügen Sie dem Stammverzeichnis Ihres Beispiels eine Readme.md hinzu.

   Dies sollte eine kurze Beschreibung des Codes enthalten und Personen auf den Artikel verweisen, der auf das Beispiel verweist.