Mendistribusikan cuplikan kode sebagai ekstensi Visual Studio

Anda dapat memberikan cuplikan kode kepada teman Anda dan meminta mereka menginstal cuplikan di komputer mereka sendiri dengan menggunakan Code Snippets Manager. Namun, jika Anda memiliki beberapa cuplikan untuk didistribusikan atau ingin mendistribusikannya secara lebih luas, Anda dapat menyertakan file cuplikan Anda dalam ekstensi Visual Studio. Pengguna Visual Studio kemudian dapat menginstal ekstensi untuk mendapatkan cuplikan.

Prasyarat

Instal beban kerja pengembangan ekstensi Visual Studio untuk mendapatkan akses ke templat proyek Proyek VSIX.

Menyiapkan struktur direktori ekstensi

Dalam prosedur ini, Anda akan menggunakan cuplikan kode Halo Dunia yang sama yang dibuat di Panduan: Membuat cuplikan kode. Artikel ini menyediakan XML cuplikan, sehingga Anda tidak perlu kembali dan membuat cuplikan.

1. Buat proyek baru dari templat Proyek VSIX Kosong dan beri nama proyek TestSnippet.

2. Dalam proyek TestSnippet, tambahkan file XML baru dan panggil VBCodeSnippet.snippet (.snippet adalah ekstensi file baru). Ganti konten dengan XML berikut:

   <?xml version="1.0" encoding="utf-8"?>
   <CodeSnippets
       xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
     <CodeSnippet Format="1.0.0">
       <Header>
         <Title>Hello World VB</Title>
         <Shortcut>HelloWorld</Shortcut>
         <Description>Inserts code</Description>
         <Author>MSIT</Author>
         <SnippetTypes>
           <SnippetType>Expansion</SnippetType>
           <SnippetType>SurroundsWith</SnippetType>
         </SnippetTypes>
       </Header>
       <Snippet>
         <Code Language="VB">
           <![CDATA[Console.WriteLine("Hello, World!")]]>
         </Code>
       </Snippet>
     </CodeSnippet>
   </CodeSnippets>
   

3. Di Penjelajah Solusi, pilih simpul proyek dan tambahkan folder yang memiliki nama yang Anda inginkan untuk dimiliki cuplikan di Code Snippets Manager. Dalam hal ini, harus HelloWorldVB.

4. Pindahkan file .snippet ke folder HelloWorldVB .

5. Pilih file .snippet di Penjelajah Solusi, dan di jendela Properti pastikan Tindakan Build diatur ke Konten, Salin ke Direktori Output diatur ke Salin selalu, dan Sertakan dalam VSIX diatur ke true.

Menambahkan file .pkgdef

1. Tambahkan file teks ke folder HelloWorldVB dan beri nama HelloWorldVB.pkgdef. File ini digunakan untuk menambahkan kunci tertentu ke registri. Untuk informasi selengkapnya, lihat Menampilkan registri untuk cuplikan (Opsional).

2. Tambahkan baris berikut ke file.

   // Visual Basic
   [$RootKey$\Languages\CodeExpansions\Basic\Paths]
   "HelloWorldVB"="$PackageFolder$"
   

   Jika Anda memeriksa kunci ini, Anda dapat melihat cara menentukan bahasa selain Visual Basic.

3. Pilih file .pkgdef di Penjelajah Solusi, dan di jendela Properti pastikan bahwa:

   • Tindakan Build diatur ke Konten
   • Salin ke Direktori Output diatur ke Salin selalu
   • Sertakan dalam VSIX diatur ke true

4. Tambahkan file .pkgdef sebagai aset dalam manifes VSIX. Di file source.extension.vsixmanifest, buka tab Aset dan klik Baru.

5. Dalam dialog Tambahkan Aset Baru, atur Jenis ke Microsoft.VisualStudio.VsPackage, Sumber ke File pada sistem file, dan Jalur ke HelloWorldVB.pkgdef (yang akan muncul di menu dropdown). Pilih OK untuk menyimpan aset baru ini.

Daftarkan cuplikan

1. Buka Pengelola Cuplikan Kode Alat>dan atur Bahasa ke Dasar.

2. Pilih Tambahkan..., telusuri folder HelloWorldVB direktori solusi Anda, dan pilih Pilih Folder.

3. HelloWorldVB sekarang menjadi salah satu folder cuplikan kode. Perluas folder untuk melihat cuplikan HelloWorldVB . Pilih OK untuk menyimpan folder yang baru ditambahkan ini.

Menguji cuplikan

Sekarang Anda dapat memastikan bahwa cuplikan kode berfungsi dalam instans eksperimental Visual Studio. Instans eksperimental adalah salinan kedua Visual Studio yang terpisah dari yang Anda gunakan untuk menulis kode. Ini memungkinkan Anda untuk mengerjakan ekstensi tanpa memengaruhi lingkungan pengembangan Anda.

1. Bangun proyek dan mulai penelusuran kesalahan.

   Instans kedua Visual Studio muncul.

2. Uji cuplikan. Dalam instans eksperimental, buka proyek Visual Basic dan buka salah satu file kode. Letakkan kursor Anda di suatu tempat dalam kode, klik kanan, dan pada menu konteks pilih Cuplikan, lalu Sisipkan Cuplikan.

3. Klik dua kali folder HelloWorldVB. Anda akan melihat pop-up Sisipkan Cuplikan : HelloWorldVB > yang memiliki dropdown HelloWorldVB. Klik dua kali menu dropdown HelloWorldVB.

   Baris berikut ditambahkan ke file kode:

   Console.WriteLine("Hello, World!")
   

Menampilkan registri untuk cuplikan (Opsional)

File .pkgdef digunakan untuk menambahkan kunci tertentu ke registri. Setelah Anda mendaftarkan cuplikan, jika Anda perlu melihat kunci registri di sarang registri privat, Anda dapat menemukannya di bawah kunci bawah kunci berikut:

Visual Studio 2022: HKEY_USERS\IsolatedHiveName\Software\Microsoft\VisualStudio\17.0_configID\Languages\CodeExpansions\Basic\Paths

Visual Studio 2019: HKEY_USERS\IsolatedHiveName\Software\Microsoft\VisualStudio\16.0_configID\Languages\CodeExpansions\Basic\Paths

Untuk melihat kunci registri di lokasi ini, pertama-tama tutup Visual Studio, buka editor registri, lalu muat sarang registri privat ke HKEY_USERS.

Penting

Jika Anda memeriksa registri, pastikan Anda membongkar sarang registri privat sebelum memulai Visual Studio.

Misalnya, kunci registri mungkin muncul seperti yang ditunjukkan di sini.

Konten terkait

• Apa itu cuplikan Kode?