.NET サンプル

このリポジトリには、以下のトピックの一部であるすべてのサンプル コードが含まれています。 .NET のドキュメントを参照してください。いくつかの異なるプロジェクトがあります はサブフォルダに整理されています。これらのサブフォルダは同様に編成されています NETのドキュメントの組織に。一部の記事には、複数のサンプルが関連付けられています。

コンテンツ チームは、dotnet/docs リポジトリとdotnet/dotnet-api-docsリポジトリで .NET ドキュメントの問題を追跡します。このリポジトリでは課題がオフになっています。既存のサンプルに対する問題と、それらのリポジトリ内の新しいサンプルの提案をファイルします。場所がわからない場合は、ドットネット/ドキュメントを選択してください。このプロセスでは、各サンプルの概念を説明する記事に関連する問題が保持されます。最良のプロセスは、各ドキュメントページの下部にあるフィードバックコントロールから問題を提出することです。

• 既存のサンプルの場合は、サンプルを含むページに問題を報告します。
• 新しいサンプルを提案するには、新しいサンプルを表示するインデックス ページで問題を報告します。

このリポジトリ内のコードは、アプリケーションまたはライブラリのシナリオを示すプログラムを表します。これらのサンプルでは、多くの場合、複数のテクノロジ、機能、またはツールキットが使用されます。各サンプルには、サンプルを説明する readme.md ファイルと、詳細情報のリソースへのリンクがあります。

サンプルはビルド可能なプロジェクトである必要があります。これらのプロジェクトはビルドし、 特定のサンプルで可能な限り幅広いプラットフォームで実行します。実際には、可能な場合は .NET Core ベースのコンソール アプリケーションを構築することを意味します。Web または UI フレームワークに固有のサンプルでは、必要に応じてこれらのツールを追加する必要があります。例としては、Web アプリケーション、モバイル アプリ、WPF または WinForms アプリなどがあります。

すべてのコードにCIシステムを導入するために取り組んでいます。サンプルを更新するときは、各更新がビルド可能物の一部であることを確認してください プロジェクト。理想的には、サンプルの正確性のテストも追加します。

サンプルのビルド

.NET Core SDK と共にインストールされる .NET Core CLI を使用して、任意の .NET Core サンプルをビルドします。次に、実行します サンプルのディレクトリにある CLI からの次のコマンド:

dotnet build
dotnet run

これらは、必要な依存関係をインストールし、プロジェクトをビルドして実行します それぞれプロジェクト。

複数プロジェクトのサンプルのルート ディレクトリに命令があります。 ファイル。

README.md

特に明記されていない限り、すべてのサンプルはコマンドラインからビルドされます。 .NET Core でサポートされている任意のプラットフォーム。いくつかのサンプルがあります Visual Studio に固有であり、Visual Studio 2017 以降が必要です。で さらに、一部のサンプルはプラットフォーム固有の機能を示しており、 特定のプラットフォーム。その他のサンプルとスニペットには .NET Framework が必要です。 Windows プラットフォームで実行され、次の開発者パックが必要になります。 ターゲット フレームワークのバージョン。

新しいサンプルの作成

コード サンプルを追加する場合:

1. サンプルは、ビルド可能なプロジェクトの一部である必要があります。可能な場合は、.NET Core でサポートされているすべてのプラットフォームでプロジェクトをビルドする必要があります。ただし、プラットフォーム固有の機能またはプラットフォーム固有のツールを示すサンプルは例外です。

2. サンプルは、一貫性を維持するためにランタイム コーディング スタイルに準拠している必要があります。

   • さらに、新しいオブジェクトをインスタンス化する必要のないことを示すときは、インスタンスメソッドではなくメソッドの使用を好みます。

     static

3. サンプルには、適切な例外処理を含める必要があります。サンプルのコンテキストでスローされる可能性のあるすべての例外を処理する必要があります。たとえば、Console.ReadLineメソッドを呼び出してユーザー入力を取得するサンプルでは、入力文字列が引数としてメソッドに渡されるときに、適切な例外処理を使用する必要があります。同様に、サンプルでメソッド呼び出しの失敗が予想される場合は、結果の例外を処理する必要があります。Exception やSystemExceptionなどの基本クラスの例外ではなく、メソッドによってスローされた特定の例外を常に処理します。

4. サンプルでスタンドアロン パッケージをビルドする場合は、サンプルで使用されるランタイムに加えて、CI ビルド システムで使用されるランタイムを含める必要があります。

   • win7-x64

   • win8-x64

   • win81-x64

   • ubuntu.16.04-x64

これらのプロジェクトを構築するためのCIシステムをまもなく導入する予定です。

サンプルを作成するには:

1. 問題を提出するか、作業中の既存の問題にコメントを追加します。

2. サンプルで示されている概念を説明するトピックを記述します (例:)。

   docs/standard/linq/where-clause.md

3. サンプルを記述します (例:WhereClause-Sample1.cs)。

4. サンプルを呼び出す Main エントリ ポイントを持つプログラムを作成します.cs。既に存在する場合は、サンプルに呼び出しを追加します。

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

5. ソリューション ファイルにプロジェクトが 1 つしか含まれていない場合は、チェックインしないでください。

サンプルをビルドして実行するには:

1. サンプル フォルダーに移動し、ビルドしてエラーを確認します。

   dotnet build

2. サンプルを実行します。

   dotnet run

3. サンプルのルート ディレクトリにREADME.mdを追加します。

   これには、コードの簡単な説明を含め、サンプルを参照する記事を参照する必要があります。