samples

.NET樣品

此存儲庫包含.NET文檔中任何主題的一部分的所有示例代碼。子食子中有幾個不同的項目。這些子折疊者的組織類似於.NET的文檔組織。其中一些文章將有多個與它們相關的樣本。

內容團隊在dotnet/docs和dotnet/dotnet-api-docs存儲庫中跟踪.NET文檔的問題。該存儲庫已關閉問題。針對這些存儲庫中的新樣本的現有樣本提出問題和建議。如果不確定在哪裡，請選擇dotnet/docs。此過程使與解釋每個樣本概念的文章相關的問題保持了問題。最好的過程是從每個文檔頁面底部的反饋控件提交問題：

• 對於現有樣本，請在頁面上使用樣本提交問題。
• 要建議新樣本，請在您要查看新樣本的索引頁面上提交問題。

此存儲庫中的代碼表示演示應用程序或庫場景的程序。這些樣品通常使用多個技術，功能或工具包。每個示例都有一個readme.md文件，可以解釋示例並鏈接到資源以獲取更多信息。

樣本應是可建造的項目。這些項目應在給定樣本的最廣泛平台上構建和運行。實際上，這意味著在可能的情況下構建.NET基於.NET核心的控制台應用程序。特定於Web或UI框架的樣本應根據需要添加這些工具。示例包括Web應用程序，移動應用程序，WPF或Windows表單應用程序等。

我們正在努力為所有代碼建立CI系統。當您對樣本進行任何更新時，請確保每個更新都是可建造項目的一部分。理想情況下，還要添加測試，以了解樣品的正確性。

建立樣本

使用.NET Core SDK安裝的.NET Core CLI構建任何.NET核心樣本。然後在任何樣本的目錄中從CLI運行這些命令：

 dotnet build
dotnet run

這些將分別安裝任何必要的依賴項，構建項目並分別運行項目。

多項目樣本在README.md文件中的根目錄中具有指令。

除了指出，所有樣本都從.NET Core支持的任何平台上的命令行構建。有一些特定於Visual Studio的樣本，需要Visual Studio 2017或以後。此外，某些樣品顯示了特定於平台的功能，並且需要特定的平台。其他樣本和摘要需要.NET框架並將在Windows平台上運行，並且需要開發人員包的目標框架版本。

創建新樣本

如果您想添加代碼示例：

1. 您的樣本必須是可建造項目的一部分。在可能的情況下，項目應在.NET Core支持的所有平台上構建。此類例外是展示特定於平台的功能或平台特異性工具的樣本。

2. 您的樣本應符合運行時編碼樣式以保持一致性。

   • 此外，在演示不需要實例化新對象的內容時，我們更喜歡使用static方法而不是實例方法。

3. 您的樣本應包括適當的例外處理。它應該處理所有可能在樣本背景下拋出的例外。例如，調用Console.Readline方法檢索用戶輸入的示例應使用適當的異常處理，當輸入字符串作為參數傳遞給方法時。同樣，如果您的樣本期望方法調用失敗，則必須處理結果的異常。始終處理該方法拋出的特定異常，而不是基類異常，例如異常或系統刪除。

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. 創建一個帶有主入口點的program.cs來調用您的樣本。如果已經有一個，請將調用添加到您的示例中：

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

5. 如果僅包含一個項目，請勿檢查解決方案文件。

構建並運行樣本：

1. 轉到示例文件夾並構建以檢查錯誤：

    dotnet build

2. 運行樣本：

    dotnet run

3. 將readme.md添加到樣品的根目錄中。

   這應該包括對代碼的簡要說明，並將人們推薦給引用樣本的文章。