Erfahren Sie, wie Sie an den Repositorys der .NET-Dokumentation mitwirken können.Learn how to contribute to the .NET docs repositories

Vielen Dank, dass Sie an der .NET-Dokumentation mitwirken möchten.Thank you for your interest in contributing to the .NET documentation!

In diesem Artikel erfahren Sie, wie Sie an Artikeln und Codebeispielen der .NET-Dokumentation mitwirken können.This document covers the process for contributing to the articles and code samples that are hosted on the .NET documentation site. Bei Änderungen kann es sich nur um das Korrigieren von Tippfehlern oder sogar um das Hinzufügen neuer Artikel handeln.Contributions may be as simple as typo corrections or as complex as new articles.

Die .NET-Dokumentation besteht aus mehreren Repositorys:The .NET documentation site is built from multiple repositories:

Issues zu allen diesen Repositorys werden im Repository dotnet/docs erfasst.Issues for all these repositories are tracked in the dotnet/docs repository.

Richtlinien für BeiträgeGuidelines for contributions

Wir schätzen Beiträge zur Dokumentation, die aus der Community kommen. Im Folgenden sind einige Leitlinien aufgelistet, die Sie beachten sollten, wenn Sie an der .NET-Dokumentation mitwirken:We appreciate community contributions to docs. The following list shows some guiding rules to keep in mind when you're contributing to the .NET documentation:

  • Keine unvermittelten großen Pull Requests.DON'T surprise us with large pull requests. Eröffnen Sie stattdessen ein Issue, und beginnen Sie eine Diskussion, sodass sich die Teilnehmer auf eine Richtung einigen können, bevor Sie viel Zeit investieren.Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
  • Befolgen Sie diese Anweisungen und die Richtlinien für Sprache und Stil.DO follow these instructions and voice and tone guidelines.
  • Verwenden Sie die Vorlage als Ausgangspunkt für Ihre Arbeit.DO use the template file as the starting point of your work.
  • Erstellen Sie einen separaten Branch in Ihrer Fork, bevor Sie an einem Artikel arbeiten.DO create a separate branch on your fork before working on the articles.
  • Befolgen Sie den Workflow für GitHub Flow.DO follow the GitHub flow.
  • Bloggen oder twittern Sie über Ihre Beiträge.DO blog and tweet (or whatever) about your contributions if you like!

Durch diese Richtlinien wird der Ablauf für Sie und für uns erleichtert.Following these guidelines will ensure a better experience for you and for us.

So tragen Sie zur .NET-Dokumentation beiMake a contribution to .NET docs

Schritt 1: Wenn Sie neue Inhalte erstellen oder bestehenden Inhalt überprüfen, öffnen Sie ein Issue, in dem Sie beschreiben, was Sie vorhaben.Step 1: If you're interested in writing new content or in thoroughly revising existing content, open an issue describing what you want to do. Der Inhalt im Ordner docs ist in Abschnitte unterteilt, die im Inhaltsverzeichnis erfasst werden.The content inside the docs folder is organized into sections that are reflected in the Table of Contents (TOC). Definieren Sie, wo im Inhaltsverzeichnis sich das Thema befinden soll.Define where the topic will be located in the TOC. Holen Sie Feedback zu Ihrem Vorschlag ein.Get feedback on your proposal.

Alternative:-or-

Wählen Sie ein vorhandenes Issue aus, und beheben Sie es.Choose an existing issue and address it. Sie können ebenfalls die Liste open issues (Offene Issues) ansehen und an einem Issue mitwirken, der Sie interessiert.You can look at our open issues list and volunteer to work on the ones you're interested in:

  • Filtern Sie nach der Bezeichnung good-first-issue, um nach guten ersten Issues zu suchen.Filter by the good-first-issue label for, well, good first issues.
  • Filtern Sie nach der Bezeichnung up-for-grabs, um nach Issues zu suchen, die für einen Communitybeitrag geeignet sind.Filter by the up-for-grabs label for issues appropriate for community contribution. Diese Issues erfordern in der Regel nur minimalen Kontext.These issues usually require minimal context.
  • Erfahrene Mitwirkende können beliebige relevante Issues lösen.Experienced contributors can tackle any issues of interest.

Wenn Sie ein entsprechendes Issue finden, fügen Sie einen Kommentar hinzu, um zu fragen, ob es noch offen ist.When you find an issue to work on, add a comment to ask if it's open.

Sobald Sie eine Aufgabe ausgewählt haben, an der Sie arbeiten möchten, befolgen Sie den Leitfaden für die ersten Schritte, um ein GitHub-Konto zu erstellen und Ihre Umgebung einzurichten.Once you've picked a task to work on, follow the get started guide to create a GitHub account and set up your environment.

Schritt 2: Forken Sie nach Bedarf die Repositorys /dotnet/docs, dotnet/samples, dotnet/dotnet-api-docs, dotnet/roslyn-api-docs oder dotnet/ml-api-docs, und erstellen Sie einen Branch für Ihre Änderungen.Step 2: Fork the /dotnet/docs, dotnet/samples, dotnet/dotnet-api-docs, dotnet/roslyn-api-docs, or dotnet/ml-api-docs repos as needed and create a branch for your changes.

Wenn Sie nur kleine Änderungen vornehmen müssen, finden Sie die entsprechenden Anweisungen für das Bearbeiten in GitHub auf der Startseite des Leitfadens für Mitwirkende.For small changes, see the instructions on editing in GitHub on the home page of the contributor guide.

Schritt 3: Nehmen Sie Änderungen an diesem neuen Branch vor.Step 3: Make the changes on this new branch.

Wenn es sich um einen neuen Artikel handelt, können Sie diese Vorlage als Ausgangspunkt verwenden.If it's a new topic, you can use this template file as your starting point. Diese enthält die Richtlinien für das Schreiben und erläutert die Metadaten, die für jeden Artikel erforderlich sind, z.B. Informationen zum Autor.It contains the writing guidelines and also explains the metadata required for each article, such as author information. Weitere Informationen zur Markdownsyntax, die auf der docs.microsoft.com-Website verwendet wird, finden Sie in der Markdownreferenz.For more information on the Markdown syntax used in the docs.microsoft.com site, see Markdown reference.

Navigieren Sie zu dem Ordner, der der Position im Inhaltsverzeichnis entspricht, die Sie in Schritt 1 für Ihren Artikel festgelegt haben.Navigate to the folder that corresponds to the TOC location determined for your article in step 1. Dieser Ordner enthält die Markdowndateien für alle Artikel in diesem Abschnitt.That folder contains the Markdown files for all articles in that section. Erstellen Sie bei Bedarf einen neuen Ordner, in dem Sie die Dateien speichern können, aus denen Ihr Inhalt besteht.If necessary, create a new folder to place the files for your content. Der Hauptartikel für diesen Abschnitt heißt index.md.The main article for that section is called index.md.

Erstellen Sie für Bilder und andere statische Ressourcen einen Unterordner namens media in dem Ordner, der Ihren Artikel enthält (falls noch nicht vorhanden).For images and other static resources, create a subfolder called media inside the folder that contains your article, if it doesn't already exist. Erstellen Sie im Ordner media einen Unterordner mit dem Namen des Artikels (außer für die Indexdatei).Inside the media folder, create a subfolder with the article name (except for the index file).

Erstellen Sie für Codeausschnitte einen Unterordner namens snippets (Codeausschnitte) in dem Ordner, der Ihren Artikel enthält (falls noch nicht vorhanden).For code snippets, create a subfolder called snippets inside the folder that contains your article, if it doesn't already exist. Erstellen Sie im Ordner snippets einen Unterordner mit dem Artikelnamen.Inside the snippets folder, create a subfolder with the article name. In den meisten Fällen haben Sie Codeausschnitte für die wichtigsten drei .NET-Hauptsprachen C#, F# und Visual Basic.In most cases, you'll have code snippets for all three of the main .NET languages, C#, F#, and Visual Basic. Erstellen Sie in diesem Fall Unterordner namens csharp, fsharp und vb für jedes der drei Projekte.In that case, create subfolders named csharp, fsharp, and vb for each of the three projects. Wenn Sie einen Codeausschnitt für einen Artikel unter den Ordnern docs/csharp, docs/fsharp oder docs/visual-basic erstellen, wird der Ausschnitt nur in einer Sprache angezeigt, sodass Sie den Sprachordner weglassen können.If you're creating a snippet for an article under the docs/csharp, docs/fsharp, or docs/visual-basic folders, the snippet will only be in one language so you can omit the language subfolder.

Codeausschnitte sind kleine fokussierte Codebeispiele, die die in diesem Artikel behandelten Konzepte veranschaulichen.Code snippets are small, focused examples of code that demonstrate the concepts covered in an article. Größere Programme, die für den Download und die Durchsuchung vorgesehen sind, sollten sich im dotnet/samples-Repository befinden.Larger programs intended for download and exploration should be located in the dotnet/samples repository. Vollständige Beispiele werden im Abschnitt zum Beitrag zu Beispielen behandelt.Full samples are covered in the section on Contributing to samples.

Beispiel für die PaketordnerstrukturExample folder structure

docs
  /about
  /core
    /porting
      porting-overview.md
      /media
        /porting-overview
          portability_report.png
      /snippets
        /porting-overview
          /csharp
            porting.csproj
            porting-overview.cs
            Program.cs
          /fsharp
            porting.fsproj
            porting-overview.fs
            Program.fs
          /vb
            porting.vbproj
            porting-overview.vb
            Program.vb

Hinweis

Die Sprachordner unter „snippets“ werden im Sprachleitfaden nicht benötigt. Dort wird nur eine Sprache angenommen.The language folders under snippets are not needed in the language guide area, where only one language is assumed.

In der oben dargestellten Struktur ist ein Image enthalten (portability_report.png) sowie drei Codeprojekte, die Codeausschnitte enthalten. Diese Codeausschnitte sind wiederum im Artikel porting-overview.md zu finden.The structure shown above includes one image, portability_report.png, and three code projects that include code snippets that are included in the porting-overview.md article. Eine akzeptierte alternative Struktur enthält ein Projekt pro Sprache, das alle Ausschnitte für alle Artikel in diesem Ordner enthält.An accepted alternative structure contains one project per language that contains all snippets for all articles in that folder. Diese Alternative wurde in den Sprachreferenzbeispielen aufgrund sehr kleiner Ausschnitte verwendet, um die Sprachsyntax zu veranschaulichen.This alternative has been used in the language reference areas because of very small snippets to demonstrate language syntax. In anderen Bereichen wird davon abgeraten.It is discouraged in other areas.

Aus historischen Gründen werden viele der enthaltenen Ausschnitte im Ordner /samples des dotnet/docs-Repositorys gespeichert.For historical reasons, many of the included snippets are stored under the /samples folder in the dotnet/docs repository. Wenn Sie wesentliche Änderungen an einem Artikel vornehmen, sollten diese Ausschnitte in die neue Struktur verschoben werden.If you're making major changes to an article, those snippets should be moved to the new structure. Verschieben Sie keine Ausschnitt für nur kleine Änderungen.Do not move snippets for small changes.

Schritt 4: Senden Sie einen Pull Request (PR) von Ihrem Branch zum Masterbranch.Step 4: Submit a Pull Request (PR) from your branch to the master branch.

Wichtig

Die Kommentarautomatisierung ist derzeit nicht für die Repositorys für die .NET-Dokumentation verfügbar.The comment automation functionality is not available on any of the .NET docs repositories at this time. Die Mitglieder des Teams für die .NET-Dokumentation überprüfen und mergen Ihren Pull Request.Members of the .NET docs team will review and merge your PR.

Jeder Pull Request sollte in der Regel nur ein Problem beheben.Each PR should usually address one issue at a time. Mit einem Pull Request können eine oder mehrere Dateien geändert werden.The PR can modify one or multiple files. Wenn Sie mehrere Probleme in verschiedenen Dateien beheben, sollten Sie mehrere Pull Requests erstellen.If you're addressing multiple fixes on different files, separate PRs are preferred. Wenn Sie Beispiele erstellen und Markdown aktualisieren, müssen Sie für die Beispiele einen separaten Pull Request erstellen.If you're creating samples as well as updating markdown, you'll need to create a separate PR for samples.

Wenn Ihr Pull Request ein vorhandenes Problem behebt, fügen Sie das Schlüsselwort Fixes #Issue_Number zur Commitnachricht oder zur Beschreibung des Pull Requests hinzu.If your PR fixes an existing issue, add the Fixes #Issue_Number keyword to the commit message or PR description. Dadurch wird das Issue automatisch geschlossen, wenn der Pull Request gemerget wurde.That way, the issue is automatically closed when the PR is merged. Weitere Informationen finden Sie unter Closing issues via commit messages (Schließen von Issues über Commitnachrichten).For more information, see Closing issues via commit messages.

Das .NET-Team überprüft Ihren Pull Request anschließend und teilt Ihnen mit, ob weitere Änderungen nötig sind, um diesen zu genehmigen.The .NET team will review your PR and let you know if there are any other updates/changes necessary in order to approve it.

Schritt 5: Nehmen Sie gemäß der Absprache mit dem Team die erforderlichen Änderungen an Ihrem Branch vor.Step 5: Make any necessary updates to your branch as discussed with the team.

Die Verwalter mergen Ihren Pull Request in den Masterbranch, sobald das Feedback umgesetzt und die Änderung genehmigt wurde.The maintainers will merge your PR into the master branch once feedback has been applied and your change is approved.

Wir pushen alle Commits an den Masterbranch regelmäßig in den Livebranch. Dann können Sie Ihren Beitrag unter https://docs.microsoft.com/dotnet/ ansehen.We regularly push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/dotnet/. Diese Veröffentlichungen finden werktags in der Regel täglich statt.We typically publish daily during the work week.

Beispiele für die MitwirkungContribute to samples

Für Code, der unsere Inhalte unterstützt, wird Folgendes unterschieden:We make the following distinction for code that supports our content:

  • Samples (Beispiele): Leser können die Beispiele herunterladen und ausführen.Samples: readers can download and run the samples. Bei den Beispielen sollte es sich immer um vollständige Anwendungen oder Bibliotheken handeln.All samples should be complete applications or libraries. Wenn ein Beispiel eine Bibliothek erstellt, sollte dieses Komponententests oder eine Anwendung enthalten, mit denen der Leser den Code ausführen kann.Where the sample creates a library, it should include unit tests or an application that lets readers run the code. Häufig werden mehrere Technologien, Features oder Toolkits verwendet.They often use more than one technology, feature, or toolkit. Die Datei „readme.md“ für jedes Beispiel verweist auf den Artikel, sodass Sie sich über die Konzepte informieren können, mit denen sich die Beispiele befassen.The readme.md file for each sample will refer to the article so that you can read more about the concepts covered in each sample.
  • Snippets (Codeausschnitte): Diese stellen weniger umfangreiche Konzepte oder Tasks dar.Snippets: illustrate a smaller concept or task. Sie können zwar kompiliert werden, sind jedoch keine vollständigen Anwendungen.They compile but they are not intended to be complete applications. Sie sollten ordnungsgemäß ausgeführt werden können, sind jedoch keine Beispielanwendungen für ein bestimmtes Szenario.They should run correctly, but aren't an example application for a typical scenario. Codeausschnitte sollen so klein wie möglich sein, um ein einzelnes Konzept oder Feature zu veranschaulichen.Instead, they are designed to be as small as possible to illustrate a single concept or feature. Dabei sollte nicht mehr Code enthalten sein, als auf einen üblichen Bildschirm passt.These should be no more than a single screen of code.

Beispiele befinden sich im Repository dotnet/samples.Samples are stored in the dotnet/samples repository. Wir arbeiten an einer Lösung, damit die Struktur des Ordners „samples“ zukünftig der Struktur des Ordners „docs“ entspricht.We are working toward a model where our samples folder structure matches our docs folder structure. Es gibt folgende Standards zu beachten:Standards that we follow are:

  • Die Ordner auf oberster Ebene entsprechen den Ordnern, die sich im Repository docs auf oberster Ebene befinden.Top-level folders match the top level folders in the docs repository. Das Repository „docs“ enthält beispielsweise den Ordner machine-learning/tutorials, und die Beispiele für diese Tutorials für das maschinelle Lernen befinden sich im Ordner samples/machine-learning/tutorials.For example, the docs repository has a machine-learning/tutorials folder, and the samples for machine learning tutorials are in the samples/machine-learning/tutorials folder.

Außerdem sollten alle Beispiele, die sich in den Ordnern core und standard befinden, auf allen Plattformen, die .NET Core unterstützt, erstellt und ausgeführt werden können.In addition, all samples under the core and standard folders should build and run on all platforms supported by .NET Core. Dies wird durch unser CI-Buildsystem erzwungen.Our CI build system will enforce that. Der Ordner framework auf oberster Ebene enthält Beispiele, die nur unter Windows erstellt und überprüft werden.The top level framework folder contains samples that are only built and validated on Windows.

Beispielprojekte sollten dem Szenario entsprechend auf so vielen Plattformen wie möglich ausgeführt können.Sample projects should build and run on the widest set of platforms possible for the given sample. In der Praxis bedeutet das, dass Sie nach Möglichkeit auf .NET Core basierende Konsolenanwendungen erstellen sollten.In practice, that means building .NET Core-based console applications where possible. Beispielen, die für Web- oder Benutzeroberflächenframeworks gelten, sollten diese Tools bei Bedarf hinzugefügt werden.Samples that are specific to the web or a UI framework should add those tools as needed. Dazu zählen unter anderem Webanwendungen, mobile Apps und WPF- oder WinForms-Apps.Examples include web applications, mobile apps, WPF or WinForms apps, and so on.

Wir arbeiten an einem CI-System für jeden Code.We are working toward having a CI system in place for all code. Wenn Sie Beispiele aktualisieren, sollten Sie sicherstellen, dass jedes Update Teil eines erstellbaren Projekts ist.When you make any updates to samples, make sure each update is part of a buildable project. Fügen Sie den Beispielen im Idealfall auch Tests auf Richtigkeit hinzu.Ideally, add tests for correctness on samples as well.

Jedes vollständige Beispiel sollte die Datei readme.md enthalten.Each complete sample that you create should contain a readme.md file. In dieser Datei sollte eine kurze Beschreibung des Beispiels enthalten sein (ein bis zwei Absätze).This file should contain a short description of the sample (one or two paragraphs). Die Datei readme.md soll den Lesern vermitteln, was sie durch dieses Beispiel lernen können.Your readme.md should tell readers what they will learn by exploring this sample. Die Datei readme.md sollte ebenfalls einen Link zur Dokumentation auf der Website der .NET-Dokumentation enthalten.The readme.md file should also contain a link to the live document on the .NET documentation site. Wenn Sie festlegen möchten, wo eine bestimmte Datei im Repository dieser Website zugeordnet wird, ersetzen Sie /docs im Repositorypfad durch https://docs.microsoft.com/dotnet.To determine where a given file in the repository maps to that site, replace /docs in the repository path with https://docs.microsoft.com/dotnet.

Ihr Artikel sollte zudem Links zum Beispiel enthalten.Your topic will also contain links to the sample. Der Link sollte direkt zu dem Ordner auf GitHub führen, in dem sich das Beispiel befindet.Link directly to the sample's folder on GitHub.

Schreiben eines neuen BeispielsWrite a new sample

Beispiele sind vollständige Programme und Bibliotheken, die zum Download bereit stehen.Samples are full programs and libraries meant for download. Sie sind möglicherweise sehr klein, aber sie veranschaulichen Konzepte auf eine Weise, die es den Benutzern ermöglicht, selbst zu forschen und zu experimentieren.They may be small in scope, but they demonstrate concepts in a manner that enables people to explore and experiment on their own. Die Richtlinien für diese Beispiele stellen sicher, dass Leser diese herunterladen und erkunden können.The guidelines for samples ensure readers can download and explore. Sehen Sie sich die Beispiele zu Paralleles LINQ (PLINQ) als Beispiel für jede Richtlinie an.Examine the Parallel LINQ (PLINQ) samples as an example of each of the guidelines.

  1. Ihr Beispiel muss Teil eines erstellbaren Projekts sein.Your sample must be part of a buildable project. Die Projekte sollten nach Möglichkeit auf allen Plattformen erstellt werden können, die von .NET Core unterstützt werden.Where possible, the projects should build on all platforms supported by .NET Core. Davon ausgenommen sind Beispiele, die plattformspezifische Features oder Tools veranschaulichen.Exceptions to this are samples that demonstrate a platform specific feature or platform specific tool.

  2. Ihr Beispiel sollte aus Gründen der Konsistenz dem corefx-Codierungsstil entsprechen.Your sample should conform to the corefx coding style to maintain consistency.

    Zudem sollten Sie static-Methoden anstelle von Instanzmethoden verwenden, wenn Sie etwas veranschaulichen möchten, für das die Instanziierung von Objekten nicht erforderlich ist.Additionally, we prefer the use of static methods rather than instance methods when demonstrating something that doesn't require instantiating a new object.

  3. Ihre Beispiele sollten eine angemessene Ausnahmebehandlung umfassen.Your sample should include appropriate exception handling. Diese sollte alle Ausnahmen behandeln, die im Kontext des Beispiels wahrscheinlich ausgelöst werden.It should handle all exceptions that are likely to be thrown in the context of the sample. In ein Beispiel, in dem die Methode Console.ReadLine aufgerufen wird, um die Benutzereingabe abzurufen, sollte beispielsweise eine angemessene Ausnahmebehandlung eingefügt werden, die verwendet werden kann, wenn die Eingabezeichenfolge als Argument an eine Methode übergeben wird.For example, a sample that calls the Console.ReadLine method to retrieve user input should use appropriate exception handling when the input string is passed as an argument to a method. Wenn ihr Beispiel erwartet, dass ein Methodenaufruf fehlschlägt, muss ebenfalls die Ausnahme behandelt werden, die ausgelöst wird.Similarly, if your sample expects a method call to fail, the resulting exception must be handled. Sie sollten immer die Ausnahmen behandeln, die von der Methode ausgelöst werden, nicht die Ausnahmen der Basisklassen wie Exception oder SystemException.Always handle the specific exceptions thrown by the method, rather than base class exceptions such as Exception or SystemException.

So erstellen Sie ein Beispiel:To create a sample:

  1. Eröffnen Sie ein Issue, oder fügen Sie einen Kommentar zu einem vorhandenen Issue hinzu, der aussagt, dass Sie an diesem arbeiten.File an issue or add a comment to an existing one that you are working on it.

  2. Schreiben Sie einen Artikel, der die Konzepte erläutert, die in Ihrem Beispiel veranschaulicht werden (z.B. docs/standard/linq/where-clause.md).Write the topic that explains the concepts demonstrated in your sample (example: docs/standard/linq/where-clause.md).

  3. Schreiben Sie Ihr Beispiel (z.B. WhereClause-Sample1.cs).Write your sample (example: WhereClause-Sample1.cs).

  4. Erstellen Sie die Datei „Program.cs“ mit einem Haupteinstiegspunkt, der Ihr Beispiel aufruft.Create a Program.cs with a Main entry point that calls your samples. Wenn diese bereits vorhanden ist, fügen Sie den Aufruf zum Beispiel hinzu:If there is already one there, add the call to your sample:

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

Codeausschnitte oder Beispiele für .NET Core werden mithilfe der .NET Core-CLI erstellt, die mit dem .NET Core SDK installiert werden kann.You build any .NET Core snippet or sample using the .NET Core CLI, which can be installed with the .NET Core SDK. So können Sie ein Beispiel erstellen und ausführen:To build and run your sample:

  1. Navigieren Sie zum Ordner des Beispiels, und führen Sie „dotnet build“ aus, um diesen auf Fehler zu überprüfen:Go to the sample folder and build to check for errors:

    dotnet build
    
  2. Führen Sie Ihr Beispiel aus:Run your sample:

    dotnet run
    
  3. Fügen Sie die Datei „readme.md“ zum Stammverzeichnis Ihres Beispiels hinzu.Add a readme.md to the root directory of your sample.

    Diese sollte eine kurze Beschreibung des Codes und einen Verweis auf den Artikel enthalten, zu dem das Beispiel gehört.This should include a brief description of the code, and refer people to the article that references the sample. Der obere Bereich der readme.md-Datei muss über die erforderlichen Metadaten für den Beispielbrowser verfügen.The top of the readme.md must have the metadata required for the samples browser. Der Headerblock muss folgende Felder enthalten:The header block should contain the following fields:

    ---
    name: "really cool sample"
    description: "Learn everything about this really cool sample."
    page_type: sample
    languages:
      - csharp
      - fsharp
      - vbnet
    products:
      - dotnet-core
      - dotnet
      - dotnet-standard
      - aspnet
      - aspnet-core
      - ef-core
    ---
    
    • Die languages-Sammlung sollte nur die Sprachen enthalten, die für Ihr Beispiel verfügbar sind.The languages collection should include only those languages available for your sample.
    • Die products-Sammlung sollte nur die für Ihr Beispiel relevanten Produkte enthalten.The products collection should include only those products relevant to your sample.

Wenn es nicht anders angegeben ist, werden alle Beispiele auf von .NET Core unterstützten Plattformen über die Befehlszeile erstellt.Except where noted, all samples build from the command line on any platform supported by .NET Core. Es gibt einige Beispiele, die speziell für Visual Studio erstellt wurden. Für diese ist Visual Studio 2017 oder höher erforderlich.There are a few samples that are specific to Visual Studio and require Visual Studio 2017 or later. Außerdem behandeln einige Beispiele plattformspezifische Features. Für diese ist eine bestimmte Plattform erforderlich.In addition, some samples show platform specific features and will require a specific platform. Andere Beispiele und Codeausschnitte werden unter Windows ausgeführt und benötigen .NET Framework sowie das Developer Pack für die Zielversion des Frameworks.Other samples and snippets require the .NET Framework and will run on Windows platforms, and will need the Developer Pack for the target Framework version.

Die interaktive C#-BenutzeroberflächeThe C# interactive experience

Für alle Beispiele, die in einem Artikel enthalten sind, wird ein Sprachtag verwendet, um die Quellsprache anzugeben.All samples included in an article use a language tag to indicate the source language. Für kurze Codebeispiele in C# kann das Sprachtag csharp-interactive verwendet werden, um ein C#-Beispiel anzugeben, das im Browser ausgeführt wird.Short code samples in C# can use the csharp-interactive language tag to specify a C# sample that runs in the browser. (Für Inlinecodebeispiele wird das Tag csharp-interactive verwendet und für Codebeispiele, die über die Quelle hinzugefügt werden, das Tag code-csharp-interactive.) Diese Codebeispiele stellen im Artikel ein Codefenster und ein Ausgabefenster dar.(Inline code samples use the csharp-interactive tag, for snippets included from source, use the code-csharp-interactive tag.) These code samples display a code window and an output window in the article. Das Ausgabefenster zeigt die Ausgabe an, die aus dem interaktiven Code entsteht, sobald der Benutzer das Beispiel ausgeführt hat.The output window displays any output from executing the interactive code once the user has run the sample.

Durch die interaktive C#-Benutzeroberfläche wird das Arbeiten mit Beispielen verändert und verbessert.The C# interactive experience changes how we work with samples. Leser können das Beispiel ausführen, um die Ergebnisse anzuzeigen.Visitors can run the sample to see the results. Es gibt einige Faktoren, anhand derer Sie entscheiden können, ob das Beispiel oder der zugehörige Text Informationen zur Ausgabe enthalten sollte.A number of factors help determine if the sample or corresponding text should include information about the output.

Wann die erwartete Ausgabe ohne Ausführung des Beispiels erkennbar sein sollteWhen to display the expected output without running the sample

  • In Artikeln für Einsteiger sollte die Ausgabe enthalten sein, sodass die Leser die Ausgabe Ihres Codes mit der erwarteten Ausgabe vergleichen können.Articles intended for beginners should provide output so that readers can compare the output of their work with the expected answer.
  • In Beispielen, bei denen die Ausgabe eine wichtige Rolle für den Artikel spielt, sollte diese enthalten sein.Samples where the output is integral to the topic should display that output. Bei Artikeln über formatierten Text sollte das Textformat ersichtlich sein, ohne das Beispiel auszuführen.For example, articles on formatted text should show the text format without running the sample.
  • Wenn das Beispiel und die erwartete Ausgabe kurz sind, sollten Sie die Ausgabe ebenfalls einfügen.When both the sample and the expected output is short, consider showing the output. Das spart dem Leser etwas Zeit.It saves a bit of time.
  • In Artikeln, die thematisieren, wie die aktuelle Kultur oder invariante Kultur sich auf die Ausgabe auswirken, sollte die erwartete Ausgabe erläutert werden.Articles explaining how current culture or invariant culture affect output should explain the expected output. Die interaktive REPL (read–eval–print-Loop) wird auf einem Linux-basierten Host ausgeführt.The interactive REPL (Read Evaluate Print Loop) runs on a Linux-based host. Die Standardkultur und die invariante Kultur erzeugen auf unterschiedlichen Betriebssystemen und Computern verschiedene Ausgaben.The default culture, and the invariant culture produce different output on different operating systems and machines. Die Ausgabe sollte in solchen Artikeln für Windows-, Linux- und Mac-Systeme erläutert werden.The article should explain the output in Windows, Linux, and Mac systems.

Wann die erwartete Ausgabe nicht im Beispiel enthalten sein sollteWhen to exclude expected output from the sample

  • Bei Artikeln mit einem Beispiel, das eine große Ausgabe generiert, sollte diese nicht in den Kommentaren enthalten sein.Articles where the sample generates a larger output should not include that in comments. Der Code wird dadurch unübersichtlich, sobald das Beispiel ausgeführt wurde.It obscures the code once the sample has been run.
  • Bei Artikeln mit einem Beispiel, das ein Thema veranschaulicht, bei dem die Ausgabe für das Verständnis nicht relevant ist.Articles where the sample demonstrates a topic, but the output isn't integral to understanding it. Wenn beispielsweise Code enthalten ist, der eine LINQ-Abfrage ausführt, um die Syntax von Abfragen zu veranschaulichen, muss nicht jedes in der Ausgabe vorhandene Element aufgeführt werden.For example, code that runs a LINQ query to explain query syntax and then display every item in the output collection.

Hinweis

Sie werden feststellen, dass einige Artikel den hier ausgeführten Richtlinien nicht entsprechen.You might notice that some of the topics are not currently following all the guidelines specified here. Wir arbeiten an der Konsistenz der Website.We're working towards achieving consistency throughout the site. Hier finden Sie die Liste der offenen Issues, die derzeit auf diesen Punkt überprüft werden.Check the list of open issues we're currently tracking for that specific goal.

Mitwirken an internationalen InhaltenContributing to International content

Beiträge für maschinell übersetzte (MT) Inhalte werden zurzeit nicht akzeptiert.Contributions for Machine Translated (MT) content are currently not accepted. Um die Qualität der maschinell übersetzten Inhalte zu verbessern, haben wir eine Umstellung auf eine neuronale MT-Engine durchgesetzt.In an effort to improve the quality of MT content, we've transitioned to a Neural MT engine. Wir akzeptieren und ermutigen Beiträge für die von Menschen übersetzte Inhalte (Human Translation, HT), die zum Trainieren der neuronalen MT-Engine verwendet werden.We accept and encourage contributions for Human Translated (HT) content, which is used to train the Neural MT engine. Im Laufe der Zeit verbessern Beiträge zu HT-Inhalten die Qualität der menschlichen als auch der maschinellen Übersetzung.So over time, contributions to HT content will improve the quality of both HT and MT. In maschinell übersetzten Themen wird ein Haftungsausschluss angezeigt, der besagt, dass ein Teil des Themas maschinell übersetzt ist, und die Schaltfläche Bearbeiten wird nicht angezeigt, da die Bearbeitung deaktiviert ist.MT topics will have a disclaimer stating that part of the topic may be MT, and the Edit button won't be displayed, as editing is disabled.

Lizenzvereinbarung für MitwirkendeContributor license agreement

Sie müssen die Lizenzvereinbarung der .NET Foundation für Mitwirkende (Contribution License Agreement, CLA) unterschreiben, bevor Ihr Pull Request gemergt wird.You must sign the .NET Foundation Contribution License Agreement (CLA) before your PR is merged. Für Projekte der .NET Foundation ist dies nur einmalig nötig.This is a one-time requirement for projects in the .NET Foundation. Weitere Informationen zu Lizenzvereinbarungen für Mitwirkende (Contribution License Agreement, CLA) finden Sie auf Wikipedia.You can read more about Contribution License Agreements (CLA) on Wikipedia.

Hier finden Sie die Lizenzvereinbarung: net-foundation-contribution-license-agreement.pdfThe agreement: net-foundation-contribution-license-agreement.pdf

Sie müssen diese nicht im Voraus unterschreiben.You don't have to sign the agreement up-front. Sie können Ihren Pull Request wie gewohnt klonen, forken und senden.You can clone, fork, and submit your PR as usual. Wenn Ihr Pull Request erstellt wird, wird dieser von einem CLA-Bot klassifiziert.When your PR is created, it is classified by a CLA bot. Wenn es sich nur um eine geringfügige Änderung handelt (z.B. das Korrigieren eines Tippfehlers), wird der Pull Request mit cla-not-required gekennzeichnet.If the change is small (for example, you fixed a typo), then the PR is labeled with cla-not-required. Andernfalls wird er als cla-required klassifiziert.Otherwise, it's classified as cla-required. Sobald Sie die Lizenzvereinbarung für Mitwirkende (CLA) unterschrieben haben, werden alle aktuellen und zukünftigen Pull Requests als cla-signed gekennzeichnet.Once you signed the CLA, the current and all future pull requests are labeled as cla-signed.