samples

ตัวอย่าง. NET

repo นี้มีรหัสตัวอย่างทั้งหมดที่เป็นส่วนหนึ่งของหัวข้อใด ๆ ภายใต้เอกสาร. NET มีหลายโครงการที่มีการจัดระเบียบในโฟลเดอร์ย่อย โฟลเดอร์ย่อยเหล่านี้มีการจัดระเบียบเช่นเดียวกับองค์กรของเอกสารสำหรับ. NET บทความบางบทความจะมีตัวอย่างมากกว่าหนึ่งรายการที่เกี่ยวข้องกับพวกเขา

ทีมเนื้อหาติดตามปัญหาสำหรับเอกสารประกอบ. NET ใน Dotnet/Docs และ Dotnet/Dotnet-Api-Docs ที่เก็บ ปัญหาถูกปิดในที่เก็บนี้ ปัญหาไฟล์กับตัวอย่างและคำแนะนำที่มีอยู่สำหรับตัวอย่างใหม่ในที่เก็บ หากคุณไม่แน่ใจว่าเลือก Dotnet/docs กระบวนการนี้ช่วยให้ปัญหาที่เกี่ยวข้องกับบทความที่อธิบายแนวคิดสำหรับแต่ละตัวอย่าง กระบวนการที่ดีที่สุดคือการยื่นปัญหาจากการควบคุมข้อเสนอแนะที่ด้านล่างของแต่ละหน้าเอกสาร:

• สำหรับตัวอย่างที่มีอยู่ให้ยื่นปัญหาบนหน้าด้วยตัวอย่าง
• หากต้องการแนะนำตัวอย่างใหม่ให้ยื่นปัญหาในหน้าดัชนีที่คุณต้องการดูตัวอย่างใหม่

รหัสในที่เก็บนี้แสดงถึงโปรแกรมที่แสดงให้เห็นถึงสถานการณ์แอปพลิเคชันหรือห้องสมุด ตัวอย่างเหล่านี้มักจะใช้เทคโนโลยีคุณสมบัติหรือชุดเครื่องมือมากกว่าหนึ่งชุด แต่ละตัวอย่างมีไฟล์ readme.md ที่อธิบายตัวอย่างและลิงก์ไปยังทรัพยากรสำหรับข้อมูลเพิ่มเติม

ตัวอย่างควรเป็นโครงการที่สามารถสร้างได้ โครงการเหล่านั้นควรสร้างและดำเนินการบนแพลตฟอร์มที่กว้างที่สุดเท่าที่จะเป็นไปได้สำหรับตัวอย่างที่กำหนด ในทางปฏิบัตินั่นหมายถึงการสร้างแอพพลิเคชั่นคอนโซลที่ใช้. NET Core หากเป็นไปได้ ตัวอย่างที่เฉพาะเจาะจงกับเว็บหรือกรอบ UI ควรเพิ่มเครื่องมือเหล่านั้นตามต้องการ ตัวอย่าง ได้แก่ เว็บแอปพลิเคชันแอพมือถือ WPF หรือแอพแบบฟอร์ม Windows และอื่น ๆ

เรากำลังดำเนินการเพื่อให้มีระบบ CI สำหรับรหัสทั้งหมด เมื่อคุณทำการอัปเดตตัวอย่างใด ๆ ตรวจสอบให้แน่ใจว่าการอัปเดตแต่ละครั้งเป็นส่วนหนึ่งของโครงการที่สร้างได้ เป็นการดีที่เพิ่มการทดสอบเพื่อความถูกต้องในตัวอย่างเช่นกัน

การสร้างตัวอย่าง

สร้างตัวอย่าง. NET Core ใด ๆ โดยใช้. NET Core CLI ซึ่งติดตั้งด้วย. NET Core SDK จากนั้นเรียกใช้คำสั่งเหล่านี้จาก CLI ในไดเรกทอรีของตัวอย่างใด ๆ :

 dotnet build
dotnet run

สิ่งเหล่านี้จะติดตั้งการพึ่งพาที่จำเป็นสร้างโครงการและเรียกใช้โครงการตามลำดับ

ตัวอย่างหลายโครงการมีคำแนะนำในไดเรกทอรีรูทของพวกเขาในไฟล์ README.md

ยกเว้นที่ระบุไว้ตัวอย่างทั้งหมดจะสร้างจากบรรทัดคำสั่งบนแพลตฟอร์มใด ๆ ที่รองรับโดย. NET Core มีตัวอย่างไม่กี่ตัวอย่างที่เฉพาะเจาะจงกับ Visual Studio และต้องการ Visual Studio 2017 หรือใหม่กว่า นอกจากนี้ตัวอย่างบางตัวอย่างแสดงคุณสมบัติเฉพาะแพลตฟอร์มและจะต้องใช้แพลตฟอร์มเฉพาะ ตัวอย่างและตัวอย่างอื่น ๆ ต้องใช้. NET Framework และจะทำงานบนแพลตฟอร์ม Windows และจะต้องมีชุดนักพัฒนาซอฟต์แวร์สำหรับรุ่นเป้าหมาย

การสร้างตัวอย่างใหม่

หากคุณต้องการเพิ่มตัวอย่างรหัส:

1. ตัวอย่างของคุณ จะต้องเป็นส่วนหนึ่งของโครงการที่สร้างได้ หากเป็นไปได้โครงการควรสร้างบนแพลตฟอร์มทั้งหมดที่สนับสนุนโดย. NET Core ข้อยกเว้นนี้เป็นตัวอย่างที่แสดงคุณสมบัติเฉพาะแพลตฟอร์มหรือเครื่องมือเฉพาะแพลตฟอร์ม

2. ตัวอย่างของคุณควรสอดคล้องกับรูปแบบการเข้ารหัสรันไทม์เพื่อรักษาความสอดคล้อง

   • นอกจากนี้เราต้องการการใช้วิธี static มากกว่าวิธีการอินสแตนซ์เมื่อแสดงให้เห็นถึงสิ่งที่ไม่จำเป็นต้องมีการสร้างอินสแตนซ์วัตถุใหม่

3. ตัวอย่างของคุณควรมี การจัดการข้อยกเว้นที่เหมาะสม ควรจัดการกับข้อยกเว้นทั้งหมดที่น่าจะถูกโยนลงไปในบริบทของตัวอย่าง ตัวอย่างเช่นตัวอย่างที่เรียกวิธีการคอนโซลรีดไลน์เพื่อดึงข้อมูลผู้ใช้ควรใช้การจัดการข้อยกเว้นที่เหมาะสมเมื่อสตริงอินพุตถูกส่งเป็นอาร์กิวเมนต์ไปยังวิธีการ ในทำนองเดียวกันหากตัวอย่างของคุณคาดว่าจะมีการเรียกใช้วิธีการที่จะล้มเหลวข้อยกเว้นที่ได้จะต้องได้รับการจัดการ จัดการกับข้อยกเว้นเฉพาะที่ถูกโยนโดยวิธีการแทนที่จะเป็นข้อยกเว้นคลาสพื้นฐานเช่นข้อยกเว้นหรือ SystemException

4. หากตัวอย่างของคุณสร้างแพ็คเกจแบบสแตนด์อโลนคุณต้องรวม Runtimes ที่ใช้โดยระบบ CI Build ของเรานอกเหนือจากตัวอย่างที่ใช้โดยตัวอย่างของคุณ:

   • 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 ไปยังไดเรกทอรีรากของตัวอย่างของคุณ

   ซึ่งควรรวมถึงคำอธิบายสั้น ๆ ของรหัสและอ้างอิงผู้คนไปยังบทความที่อ้างอิงตัวอย่าง