samples
verage
このリポジトリには、.NETドキュメントに基づくトピックの一部であるすべてのサンプルコードが含まれています。サブフォルダーで組織されているいくつかの異なるプロジェクトがあります。これらのサブフォルダーは、.NETのドキュメントの組織と同様に組織されています。一部の記事には、それらに関連付けられた複数のサンプルがあります。
コンテンツチームは、dotnet/docsおよびdotnet/dotnet-api-docsリポジトリの.netドキュメントの問題を追跡します。このリポジトリでは問題がオフになります。これらのリポジトリの新しいサンプルの既存のサンプルと提案に対する問題をファイルします。どこにいるのかわからない場合は、dotnet/docsを選択してください。このプロセスは、各サンプルの概念を説明する記事に関連する問題を保持します。最良のプロセスは、各ドキュメントページの下部にあるフィードバックコントロールから問題を提出することです。
このリポジトリのコードは、アプリケーションまたはライブラリのシナリオを示すプログラムを表します。これらのサンプルは、多くの場合、複数のテクノロジー、機能、またはツールキットを使用しています。各サンプルには、サンプルを説明し、詳細についてリソースにリンクするreadme.mdファイルがあります。
サンプルは構築可能なプロジェクトである必要があります。これらのプロジェクトは、与えられたサンプルで可能なプラットフォームの最も広いセットで構築および実行する必要があります。実際には、可能な場合は.NETコアベースのコンソールアプリケーションを構築することを意味します。 WebまたはUIフレームワークに固有のサンプルは、必要に応じてそれらのツールを追加する必要があります。例には、Webアプリケーション、モバイルアプリ、WPFまたはWindowsフォームアプリなどが含まれます。
私たちは、すべてのコードのCIシステムを導入することに取り組んでいます。サンプルの更新を行うときは、各更新がビルド可能なプロジェクトの一部であることを確認してください。理想的には、サンプルの正しさについてもテストを追加します。
.NETコアSDKでインストールされている.NETコアCLIを使用して、.NETコアサンプルを構築します。次に、サンプルのディレクトリでCLIからこれらのコマンドを実行します。
dotnet build
dotnet runこれらは、必要な依存関係をインストールし、プロジェクトを構築し、それぞれプロジェクトを実行します。
マルチプロジェクトサンプルには、 README.mdファイルのルートディレクトリに指示があります。
記載されている場合を除き、すべてのサンプルは、.NETコアによってサポートされている任意のプラットフォーム上のコマンドラインから構築されます。 Visual Studioに固有のサンプルがいくつかあり、Visual Studio 2017以降が必要です。さらに、一部のサンプルはプラットフォーム固有の機能を示し、特定のプラットフォームが必要です。他のサンプルとスニペットには.NETフレームワークが必要であり、Windowsプラットフォームで実行され、ターゲットフレームワークバージョン用に開発者パックが必要になります。
コードサンプルを追加する場合：
サンプルはビルド可能なプロジェクトの一部でなければなりません。可能であれば、プロジェクトは.NET Coreによってサポートされているすべてのプラットフォームに基づいて構築する必要があります。これの例外は、プラットフォーム固有の機能またはプラットフォーム固有のツールを示すサンプルです。
サンプルは、一貫性を維持するためにランタイムコーディングスタイルに準拠する必要があります。
staticメソッドの使用を好みます。サンプルには、適切な例外処理を含める必要があります。サンプルのコンテキストでスローされる可能性が高いすべての例外を処理する必要があります。たとえば、console.readlineメソッドを呼び出すサンプルは、ユーザー入力を取得する必要があります。入力文字列がメソッドの引数として渡されると、適切な例外処理を使用する必要があります。同様に、サンプルがメソッド呼び出しが失敗することを期待している場合、結果の例外を処理する必要があります。例外やSystemExceptionなどの基本クラスの例外ではなく、メソッドによってスローされる特定の例外を常に処理してください。
サンプルがスタンドアロンパッケージを構築する場合、サンプルで使用されるランタイムに加えて、CIビルドシステムで使用されるランタイムを含める必要があります。
win7-x64win8-x64win81-x64ubuntu.16.04-x64これらのプロジェクトをまもなく構築するためのCIシステムが整っています。
サンプルを作成するには：
問題を提出するか、既存のコメントに取り組んでいるコメントを追加します。
サンプルで示されている概念を説明するトピックを作成します（例： docs/standard/linq/where-clause.md ）。
サンプルを書きます（例： whereclause-sample1.cs ）。
サンプルを呼び出すメインエントリポイントを持つプログラムを作成します。すでにそこにある場合は、サンプルに通話を追加します。
public class Program
{
public void Main ( string [ ] args )
{
WhereClause1 . QuerySyntaxExample ( ) ;
// Add the method syntax as an example.
WhereClause1 . MethodSyntaxExample ( ) ;
}
}ソリューションファイルには1つのプロジェクトのみが含まれている場合は、チェックインしないでください。
サンプルを構築して実行するには：
サンプルフォルダーに移動してビルドしてエラーを確認します。
dotnet buildサンプルを実行します：
dotnet runサンプルのルートディレクトリにreadme.mdを追加します。
これには、コードの簡単な説明が含まれ、サンプルを参照する記事を人々に紹介する必要があります。
