Bagikan melalui

Menyebarkan Prosesor Arahan Kustom

Untuk menggunakan prosesor arahan kustom dalam Visual Studio di komputer apa pun, Anda harus mendaftarkannya dengan salah satu metode yang dijelaskan dalam topik ini.

Metode alternatifnya adalah:

  • Ekstensi Visual Studio. Ini menyediakan cara untuk menginstal dan menghapus instalasi prosesor arahan baik di komputer Anda sendiri maupun di komputer lain. Biasanya, Anda mungkin mengemas fitur lain dalam VSIX yang sama.

  • VSPackage. Jika Anda mendefinisikan VSPackage yang berisi fitur lain selain prosesor arahan, ada metode yang nyaman untuk mendaftarkan prosesor arahan.

  • Atur kunci registri. Dalam metode ini, Anda menambahkan entri registri untuk prosesor arahan.

Anda perlu menggunakan salah satu metode ini hanya jika Anda ingin mengubah templat teks Anda di Visual Studio atau MSBuild. Jika Anda menggunakan host kustom di aplikasi Anda sendiri, host kustom Anda bertanggung jawab untuk menemukan prosesor arahan untuk setiap arahan.

Menyebarkan Prosesor Arahan di VSIX

Anda dapat menambahkan prosesor arahan kustom ke Ekstensi Visual Studio (VSIX).

Anda perlu memastikan bahwa dua item berikut terkandung dalam file .vsix:

  • Rakitan (.dll) yang berisi kelas prosesor arahan kustom.

  • File .pkgdef yang mendaftarkan prosesor arahan. Nama akar file harus sama dengan rakitan. Misalnya, file Anda dapat diberi nama CDP.dll dan CDP.pkgdef.

Untuk memeriksa atau mengubah konten file .vsix, ubah ekstensi nama filenya menjadi .zip lalu buka. Setelah mengedit konten, ubah nama file kembali ke .vsix.

Ada beberapa cara untuk membuat file .vsix. Prosedur berikut menjelaskan satu metode.

Untuk mengembangkan prosesor arahan kustom dalam proyek VSIX

  1. Buat proyek Proyek VSIX baru.

  2. Di source.extension.vsixmanifest, atur jenis konten dan edisi yang didukung.

    1. Di editor manifes VSIX, pada tab Aset, pilih Baru dan atur properti item baru:

      Jenis Konten = VSPackage

      Sumber Proyek = <proyek saat ini>

    2. Klik Edisi yang Dipilih dan periksa jenis penginstalan tempat Anda ingin prosesor arahan dapat digunakan.

  3. Tambahkan file .pkgdef dan atur propertinya untuk disertakan dalam VSIX.

    1. Buat file teks dan beri nama <assemblyName>.pkgdef.

      <assemblyName> biasanya sama dengan nama proyek.

    2. Pilih di Penjelajah Solusi dan atur propertinya sebagai berikut:

      Tindakan Build = Isi

      Salin ke Direktori Output = Salin Selalu

      Sertakan dalam VSIX = True

    3. Atur nama VSIX dan pastikan ID unik.

  4. Tambahkan teks berikut ke file.

    [$RootKey$\TextTemplating]
[$RootKey$\TextTemplating\DirectiveProcessors]
[$RootKey$\TextTemplating\DirectiveProcessors\ CustomDirectiveProcessorName]
@="Custom Directive Processor description"
"Class"="NamespaceName.ClassName"
"CodeBase"="$PackageFolder$\AssemblyName.dll"

    Ganti nama berikut dengan nama Anda sendiri: CustomDirectiveProcessorName, NamespaceName, ClassName, AssemblyName.

  5. Tambahkan referensi berikut ke proyek:

    • Microsoft.VisualStudio.TextTemplating.*.0

    • Microsoft.VisualStudio.TextTemplating.Interfaces.*.0

    • Microsoft.VisualStudio.TextTemplating.VSHost.*.0

  6. Tambahkan kelas prosesor arahan kustom Anda ke proyek.

    Ini adalah kelas publik yang harus menerapkan DirectiveProcessor atau RequiresProvidesDirectiveProcessor.

Untuk menginstal Custom Directive Processor

  1. Di Windows Explorer, buka direktori build (biasanya bin\Debug atau bin\Release).

  2. Jika Anda ingin menginstal prosesor arahan di komputer lain, salin file .vsix ke komputer lain.

  3. Klik dua kali file .vsix. Alat Penginstal Ekstensi Visual Studio muncul.

  4. Mulai Visual Studio. Anda sekarang dapat menjalankan templat teks yang berisi arahan yang merujuk ke prosesor arahan kustom. Setiap arahan adalah dari bentuk ini:

    <#@ CustomDirective Processor="CustomDirectiveProcessorName" parameter1="value1" ... #>

Untuk menghapus instalasi atau menonaktifkan sementara prosesor arahan kustom

  1. Di menu Alat Visual Studio, klik Pengelola Ekstensi.

  2. Pilih VSIX yang berisi prosesor arahan, lalu klik Hapus instalan atau Nonaktifkan.

Pemecahan masalah Prosesor Arahan di VSIX

Jika prosesor arahan tidak berfungsi, saran berikut mungkin membantu:

  • Nama Prosesor yang Anda tentukan dalam direktif kustom harus cocok dengan CustomDirectiveProcessorName yang Anda tentukan dalam file .pkgdef.

  • Metode IsDirectiveSupported Anda harus kembali true ketika diteruskan nama Anda CustomDirective.

  • Jika Anda tidak dapat melihat ekstensi di Pengelola Ekstensi, tetapi sistem tidak akan mengizinkan Anda menginstalnya, hapus ekstensi dari %localappdata%\Microsoft\VisualStudio\*.0\Extensions\.

  • Buka file .vsix dan periksa isinya. Untuk membukanya, ubah ekstensi nama file menjadi .zip. Verifikasi bahwa file tersebut berisi file .dll, .pkgdef, dan extension.vsixmanifest. File extension.vsixmanifest harus berisi daftar yang sesuai di node SupportedProducts, dan juga harus berisi node VsPackage di bawah node Konten:

    <Content>

    <VsPackage>CustomDirectiveProcessor.dll</VsPackage>

    </Content>

Menyebarkan Prosesor Arahan di VSPackage

Jika prosesor arahan Anda adalah bagian dari VSPackage yang akan diinstal di GAC, Anda dapat meminta sistem membuat file .pkgdef untuk Anda.

Tempatkan atribut berikut pada kelas paket Anda:

[ProvideDirectiveProcessor(typeof(DirectiveProcessorClass), "DirectiveProcessorName", "Directive processor description.")]

Catatan

Atribut ini ditempatkan pada kelas paket, bukan kelas prosesor arahan.

File .pkgdef akan dihasilkan saat Anda membangun proyek. Ketika Anda menginstal VSPackage, file .pkgdef akan mendaftarkan prosesor arahan.

Verifikasi bahwa file .pkgdef muncul di folder build, yang biasanya bin\Debug atau bin\Release. Jika tidak muncul, buka file .csproj di editor teks, dan hapus node berikut: <GeneratePkgDefFile>false</GeneratePkgDefFile>.

Untuk informasi selengkapnya, lihat VSPackages.

Mengatur Kunci Registri

Metode menginstal prosesor arahan kustom ini adalah yang paling tidak disukai. Ini tidak menyediakan cara yang mudah mengaktifkan dan menonaktifkan prosesor arahan, dan tidak menyediakan metode mendistribusikan prosesor arahan kepada pengguna lain.

Perhatian

Salah mengedit registri bisa sangat merusak sistem Anda. Sebelum membuat perubahan pada registri, Anda harus mencadangkan semua data berharga pada komputer.

Untuk mendaftarkan prosesor arahan dengan mengatur kunci registri

  1. Jalankan regedit.

  2. Di regedit, navigasi ke

    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\*.0\TextTemplating\DirectiveProcessors

    Jika Anda ingin menginstal prosesor arahan dalam versi eksperimental Visual Studio, masukkan "Exp" setelah "11.0".

  3. Tambahkan kunci registri yang memiliki nama yang sama dengan kelas prosesor arahan.

    • Di pohon registri, klik kanan node DirectiveProcessors, arahkan ke Baru, lalu klik Kunci.

  4. Di node baru, tambahkan nilai string untuk Class dan CodeBase atau Assembly, sesuai dengan tabel berikut.

    1. Klik kanan node yang Anda buat, arahkan ke Baru, lalu klik Nilai String.

    2. Edit nama nilai.

    3. Klik dua kali nama dan edit data.

    Jika prosesor arahan kustom tidak ada di GAC, subkunci registri akan terlihat seperti tabel berikut:

Nama Jenis Data
(Default) REG_SZ (nilai tidak ditetapkan)
Kelas REG_SZ <Nama Namespace Layanan>.<Nama Kelas>
CodeBase REG_SZ <Jalur Anda>\<Nama Rakitan Anda>

Jika rakitan berada di GAC, subkunci registri akan terlihat seperti tabel berikut:

Nama Jenis Data
(Default) REG_SZ (nilai tidak ditetapkan)
Kelas REG_SZ <Nama Kelas Anda yang Sepenuhnya Memenuhi Syarat>
Rakitan REG_SZ <Nama Rakitan Anda di GAC>

Konten terkait

  • Last updated on