samples

.NET Sampel

Repo ini berisi semua kode sampel yang merupakan bagian dari topik apa pun di bawah dokumentasi .NET. Ada beberapa proyek berbeda yang diselenggarakan di sub-folder. Sub-folder ini disusun sama dengan organisasi dokumen untuk .NET. Beberapa artikel akan memiliki lebih dari satu sampel yang terkait dengannya.

Tim konten melacak masalah untuk dokumentasi .NET di repositori DOTNET/DOCS dan DOTNET/DOTNET-API-DOCS. Masalah dimatikan pada repositori ini. Masalah file terhadap sampel dan saran yang ada untuk sampel baru dalam repositori tersebut. Jika Anda tidak yakin di mana, pilih Dotnet/Docs. Proses ini membuat masalah terkait dengan artikel yang menjelaskan konsep untuk setiap sampel. Proses terbaik adalah mengajukan masalah dari kontrol umpan balik di bagian bawah setiap halaman dokumen:

• Untuk sampel yang ada, ajukan masalah pada halaman dengan sampel.
• Untuk menyarankan sampel baru, ajukan masalah pada halaman indeks tempat Anda ingin melihat sampel baru.

Kode dalam repositori ini mewakili program yang menunjukkan skenario aplikasi atau perpustakaan. Sampel -sampel ini sering menggunakan lebih dari satu teknologi, fitur, atau toolkit. Setiap sampel memiliki file readme.md yang menjelaskan sampel dan tautan ke sumber daya untuk informasi lebih lanjut.

Sampel harus menjadi proyek yang dapat dibangun. Proyek -proyek tersebut harus dibangun dan dijalankan pada set platform terluas yang mungkin untuk sampel yang diberikan. Dalam praktiknya, itu berarti membangun aplikasi konsol berbasis inti. NET jika memungkinkan. Sampel yang spesifik untuk web atau kerangka kerja UI harus menambahkan alat tersebut sesuai kebutuhan. Contohnya termasuk aplikasi web, aplikasi seluler, aplikasi WPF atau Windows Forms, dan sebagainya.

Kami berupaya memiliki sistem CI untuk semua kode. Saat Anda melakukan pembaruan untuk sampel, pastikan setiap pembaruan adalah bagian dari proyek yang dapat dibangun. Idealnya, tambahkan tes untuk kebenaran pada sampel juga.

Membangun sampel

Bangun sampel inti .NET menggunakan .NET Core CLI, yang diinstal dengan .NET Core SDK. Kemudian jalankan perintah -perintah ini dari CLI di direktori sampel apa pun:

 dotnet build
dotnet run

Ini akan menginstal setiap dependensi yang diperlukan, membangun proyek, dan menjalankan proyek masing -masing.

Sampel multi-proyek memiliki instruksi di direktori root mereka dalam file README.md .

Kecuali jika dicatat, semua sampel dibangun dari baris perintah pada platform apa pun yang didukung oleh .NET Core. Ada beberapa sampel yang spesifik untuk Visual Studio dan membutuhkan Visual Studio 2017 atau lebih baru. Selain itu, beberapa sampel menunjukkan fitur spesifik platform dan akan membutuhkan platform tertentu. Sampel dan cuplikan lain memerlukan .NET Framework dan akan berjalan pada platform Windows, dan akan memerlukan paket pengembang untuk versi Target Framework.

Membuat sampel baru

Jika Anda ingin menambahkan sampel kode:

1. Sampel Anda harus menjadi bagian dari proyek yang dapat dibangun . Jika memungkinkan, proyek harus dibangun di semua platform yang didukung oleh .NET Core. Pengecualian untuk ini adalah sampel yang menunjukkan fitur khusus platform atau alat khusus platform.

2. Sampel Anda harus sesuai dengan gaya pengkodean runtime untuk mempertahankan konsistensi.

   • Selain itu, kami lebih suka menggunakan metode static daripada metode instance ketika menunjukkan sesuatu yang tidak memerlukan instantiasi objek baru.

3. Sampel Anda harus mencakup penanganan pengecualian yang tepat . Ini harus menangani semua pengecualian yang cenderung dilemparkan dalam konteks sampel. Misalnya, sampel yang memanggil metode konsol. Demikian pula, jika sampel Anda mengharapkan panggilan metode gagal, pengecualian yang dihasilkan harus ditangani. Selalu menangani pengecualian spesifik yang dilemparkan oleh metode ini, bukan pengecualian kelas dasar seperti pengecualian atau SystemException.

4. Jika sampel Anda membangun paket mandiri, Anda harus menyertakan runtime yang digunakan oleh sistem pembuatan CI kami, di samping setiap runtime yang digunakan oleh sampel Anda:

   • win7-x64
   • win8-x64
   • win81-x64
   • ubuntu.16.04-x64

Kami akan memiliki sistem CI untuk membangun proyek ini segera.

Untuk membuat sampel:

1. Ajukan masalah atau tambahkan komentar ke yang sudah ada yang sedang Anda kerjakan.

2. Tulis topik yang menjelaskan konsep yang ditunjukkan dalam sampel Anda (Contoh: docs/standard/linq/where-clause.md ).

3. Tulis sampel Anda (Contoh: whereclause-sample1.cs ).

4. Buat program.cs dengan titik masuk utama yang memanggil sampel Anda. Jika sudah ada di sana, tambahkan panggilan ke sampel Anda:

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

5. Jangan memeriksa file solusi jika hanya berisi satu proyek.

Untuk membangun dan menjalankan sampel Anda:

1. Pergi ke folder sampel dan bangun untuk memeriksa kesalahan:

    dotnet build

2. Jalankan sampel Anda:

    dotnet run

3. Tambahkan readme.md ke direktori root sampel Anda.

   Ini harus mencakup deskripsi singkat tentang kode, dan merujuk orang ke artikel yang merujuk sampel.