.NET Compiler Platform SDK

  • Artikel

Kompiler membangun model terperinci kode aplikasi saat memvalidasi sintaksis dan semantik kode tersebut. Mereka menggunakan model ini untuk membangun output yang dapat dieksekusi dari kode sumber. .NET Compiler Platform SDK menyediakan akses ke model ini. Kami makin banyak mengandalkan fitur lingkungan pengembangan terpadu (IDE) seperti IntelliSense, refaktor, penamaan ulang cerdas, "Temukan semua referensi,” dan "Buka definisi” untuk meningkatkan produktivitas kami. Kami mengandalkan alat analisis kode untuk meningkatkan kualitas kode kami, dan generator kode untuk membantu dalam pembuatan aplikasi. Karena alat-alat ini semakin cerdas, mereka membutuhkan akses ke semakin banyak model yang hanya dibuat kompiler saat memproses kode aplikasi. Ini adalah misi inti dari API Roslyn: membuka kotak buram dan memungkinkan alat dan pengguna akhir untuk berbagi dalam kekayaan informasi yang dimiliki oleh kompiler tentang kode kami. Alih-alih menjadi penerjemah sumber-kode-masuk buram dan obyek-kode-hasil, melalui Roslyn, kompiler menjadi platform: API yang dapat Anda gunakan untuk tugas terkait-kode di alat dan aplikasi Anda.

Konsep .NET Compiler Platform SDK

.NET Compiler Platform SDK secara dramatis menurunkan hambatan ke entri untuk membuat alat dan aplikasi yang berfokus pada kode. Ini menciptakan banyak peluang untuk inovasi di bidang-bidang seperti pemrograman meta, pembuatan dan transformasi kode, penggunaan interaktif bahasa C# dan Visual Basic, dan penyematan C# dan Visual Basic dalam bahasa khusus-domain.

.NET Compiler Platform SDK memungkinkan Anda membangun penganalisis dan perbaikan kode yang menemukan dan memperbaiki kesalahan pengodean. Penganalisis memahami sintaks (struktur kode) dan semantik untuk mendeteksi praktik yang harus dikoreksi. Perbaikan kode menyediakan satu atau beberapa perbaikan yang disarankan untuk mengatasi kesalahan pengodean yang ditemukan oleh penganalisis atau diagnostik kompiler. Biasanya, penganalisis dan perbaikan kode terkait dipaketkan bersama dalam satu proyek.

Penganalisis dan perbaikan kode menggunakan analisis statis untuk memahami kode. Mereka tidak menjalankan kode atau memberikan manfaat pengujian lainnya. Namun, mereka dapat menunjukkan praktik yang sering menyebabkan bug, kode yang tidak dapat dipelihara, atau pelanggaran pedoman standar.

Selain penganalisis dan perbaikan kode, .NET Compiler Platform SDK juga memungkinkan Anda untuk membangun refaktor kode. Ini juga menyediakan satu set API yang memungkinkan Anda untuk memeriksa dan memahami basis kode C# atau Visual Basic. Karena Anda dapat menggunakan basis kode tunggal ini, Anda dapat menulis penganalisis dan perbaikan kode dengan lebih mudah dengan memanfaatkan API analisis sintaktik dan semantik yang disediakan oleh .NET Compiler Platform SDK. Dibebaskan dari tugas besar mereplikasi analisis yang dilakukan oleh kompiler, Anda dapat berkonsentrasi pada tugas yang lebih terfokus untuk menemukan dan memperbaiki kesalahan pengodean umum untuk proyek atau pustaka Anda.

Manfaat yang lebih kecil adalah bahwa penganalisis dan perbaikan kode Anda lebih kecil dan menggunakan memori yang jauh lebih sedikit ketika dimuat dalam Visual Studio daripada memori yang diperlukan jika Anda menulis basis kode Anda sendiri untuk memahami kode dalam proyek. Dengan memanfaatkan kelas yang sama yang digunakan oleh kompiler dan Visual Studio, Anda dapat membuat alat analisis statis Anda sendiri. Ini berarti tim Anda dapat menggunakan penganalisis dan perbaikan kode tanpa menimbulkan dampak yang terlihat pada kinerja IDE.

Ada tiga skenario utama untuk menulis penganalisis dan perbaikan kode:

  1. Menerapkan standar pengodean tim
  2. Memberikan panduan dengan paket pustaka
  3. Menyediakan panduan umum

Menerapkan standar pengodean tim

Banyak tim memiliki standar pengodean yang diberlakukan melalui tinjauan kode dengan anggota tim lain. Penganalisis dan perbaikan kode dapat membuat proses ini jauh lebih efisien. Tinjauan kode terjadi ketika pengembang berbagi pekerjaan mereka dengan orang lain di tim. Pengembang akan mengorbankan banyak waktu yang diperlukan untuk menyelesaikan fitur baru sebelum mendapatkan komentar. Berminggu-minggu berjalan sementara pengembang memperkuat kebiasaan yang tidak selalu cocok dengan praktik tim.

Penganalisis berjalan saat pengembang menulis kode. Pengembang mendapatkan umpan balik langsung yang mendorong untuk mengikuti panduan segera. Pengembang membangun kebiasaan untuk menulis kode yang sesuai segera setelah mereka mulai membuat prototipe. Ketika fitur siap untuk ditinjau oleh manusia, semua panduan standar telah diterapkan.

Team dapat membangun penganalisis dan perbaikan kode yang mencari praktik paling umum yang melanggar praktik pengodean tim. Keduanya dapat diinstal pada setiap komputer pengembang untuk menegakkan standar.

Tip

Sebelum membangun penganalisis Anda sendiri, periksa penganalisis bawaan. Untuk informasi selengkapnya, lihat Aturan Kode-gaya.

Memberikan panduan dengan paket pustaka

Ada banyak sekali pustaka yang tersedia untuk pengembang .NET di NuGet. Beberapa di antaranya berasal dari Microsoft, beberapa dari perusahaan pihak ketiga, dan lainnya dari anggota komunitas dan sukarelawan. Pustaka ini mendapatkan lebih banyak adopsi dan ulasan yang lebih banyak ketika pengembang berhasil dengan pustaka tersebut.

Selain menyediakan dokumentasi, Anda dapat menyediakan penganalisis dan perbaikan kode yang menemukan dan memperbaiki kesalahan penggunaan umum pustaka Anda. Koreksi langsung ini akan membantu pengembang berhasil lebih cepat.

Anda dapat mengemas penganalisis dan perbaikan kode dengan pustaka Anda di NuGet. Dalam skenario itu, setiap pengembang yang menginstal paket NuGet Anda juga akan menginstal paket penganalisis. Semua pengembang yang menggunakan pustaka Anda akan segera mendapatkan panduan dari tim Anda dalam bentuk umpan balik langsung tentang kesalahan dan koreksi yang disarankan.

Menyediakan panduan umum

Komunitas pengembang .NET telah menemukan, melalui pengalaman, pola yang bekerja dengan baik dan pola yang paling harus dihindari. Beberapa anggota komunitas telah membuat penganalisis yang menegakkan pola yang direkomendasikan tersebut. Sebagaimana yang makin kita pahami, selalu ada ruang untuk ide-ide baru.

Penganalisis ini dapat diunggah ke Visual Studio Marketplace dan diunduh oleh pengembang menggunakan Visual Studio. Pendatang baru pada bahasa dan platform mempelajari praktik yang diterima dengan cepat dan menjadi produktif lebih awal dalam perjalanan .NET mereka. Ketika makin sering digunakan, komunitas tersebut akan mengadopsi praktik-praktik ini.

Langkah berikutnya

.NET Compiler Platform SDK mencakup model objek bahasa terbaru untuk pembuatan kode, analisis, dan refaktor. Bagian ini memberikan gambaran umum konseptual tentang .NET Compiler Platform SDK. Detail lebih lanjut dapat ditemukan di bagian mulai cepat, sampel, dan tutorial.

Anda dapat mempelajari lebih lanjut tentang konsep di .NET Compiler Platform SDK dalam lima topik ini:

Untuk memulai, Anda harus menginstal .NET Compiler Platform SDK:

Instruksi penginstalan - Alat penginstal Visual Studio

Ada dua cara berbeda untuk menemukan .NET Compiler Platform SDK di Alat penginstal Visual Studio:

Menginstal menggunakan Alat penginstal Visual Studio - Tampilan Beban Kerja

.NET Compiler Platform SDK tidak dipilih secara otomatis sebagai bagian dari beban kerja pengembangan ekstensi Visual Studio. Anda harus memilihnya sebagai komponen opsional.

  1. Jalankan Alat Penginstal Visual Studio
  2. Pilih Ubah
  3. Periksa beban kerja pengembangan ekstensi Visual Studio.
  4. Buka simpul pengembangan ekstensi Visual Studio di pohon ringkasan.
  5. Centang kotak untuk .NET Compiler Platform SDK. Anda akan menemukannya terakhir di bawah komponen opsional.

Secara opsional, Anda juga ingin editor DGML menampilkan grafik di visualizer:

  1. Buka simpul Komponen individual di pohon ringkasan.
  2. Centang kotak untuk Editor DGML

Menginstal menggunakan Alat penginstal Visual Studio Installer - tab Komponen individual

  1. Jalankan Alat Penginstal Visual Studio
  2. Pilih Ubah
  3. Pilih tab Komponen individu
  4. Centang kotak untuk .NET Compiler Platform SDK. Anda akan menemukannya di bagian atas di bawah bagian Kompiler, alat build, dan runtime.

Secara opsional, Anda juga ingin editor DGML menampilkan grafik di visualizer:

  1. Centang kotak untuk Editor DGML. Anda akan menemukannya di bawah bagian Alat kode.