Bagikan melalui

Cuplikan kode dan cara menggunakannya

  • Artikel

Cuplikan kode adalah blok kecil kode yang dapat digunakan kembali yang dapat Anda tambahkan ke file kode. Cuplikan biasanya berisi blok kode yang sering digunakan seperti Try...Finally atau If...Else blok. Anda juga dapat menggunakan cuplikan kode untuk menambahkan seluruh kelas atau metode.

Cuplikan kode memiliki judul yang Anda gunakan untuk memilih cuplikan, dan dapat memiliki nama pintasan yang dapat Anda ketik untuk menyisipkan cuplikan. Cuplikan juga dapat berisi parameter pengganti, yang bertindak sebagai tempat penampung. Cuplikan tersedia untuk banyak bahasa, termasuk C#, C++, dan Visual Basic.

Cuplikan ekspansi dan dikelilingi dengan cuplikan

Anda dapat menambahkan dua jenis cuplikan kode ke kode Anda:

  • Cuplikan ekspansi ditambahkan pada titik penyisipan tertentu.
  • Cuplikan yang dikelilingi ditambahkan di sekitar kode yang dipilih, dan hanya tersedia untuk C# dan C++.

Menemukan cuplikan yang tersedia

Untuk melihat cuplikan yang tersedia untuk bahasa, pilih Pengelola Cuplikan Kode Alat>dari bilah menu, atau tekan Ctrl+K, B, lalu pilih bahasa yang Anda inginkan dari menu dropdown.

Cuplikan layar kotak dialog Manajer Cuplikan Kode.

Untuk membuat dan mengimpor cuplikan Anda sendiri sehingga muncul di daftar cuplikan, lihat Panduan: Membuat cuplikan kode di Visual Studio.

Menambahkan cuplikan ke file kode

Untuk menambahkan cuplikan ke file kode:

  1. Di editor kode, letakkan kursor Anda atau pilih kode C# atau C++ tempat Anda ingin menambahkan cuplikan.

  2. Ikuti salah satu tindakan berikut:

    • Pada bilah menu Visual Studio, pilih Edit Cuplikan>Sisipkan IntelliSense>atau Edit>IntelliSense>Surround With.
    • Klik kanan, dan pilih Cuplikan>Sisipkan Cuplikan atau Sekeliling Cuplikan>Dengan dari menu konteks.
    • Dari keyboard, tekan Ctrl+K, X untuk cuplikan ekspansi, atau Ctrl+K, S untuk cuplikan yang dikelilingi.

  3. Klik dua kali cuplikan yang Anda inginkan di daftar dropdown, atau ketik pintasan cuplikan dan tekan Tab atau Enter.

Menambahkan cuplikan ekspansi

Misalnya, cuplikan ekspansi tryf C# menambahkan blok berikut Try...Finally :

try
{

}
finally
{

}

Untuk menambahkan cuplikan ekspansi ini:

  1. Di editor kode, posisikan kursor Tempat Anda ingin menambahkan cuplikan.
  2. Klik kanan dan pilih Sisipkan Cuplikan dari menu konteks klik kanan, atau gunakan bilah menu atau perintah keyboard.
  3. Buka folder Visual C#, lalu klik dua kali tryf di daftar dropdown, atau pilih tryf dan tekan Tab atau Enter.

Tip

Anda juga dapat menempatkan kursor di titik penyisipan, ketik tryf, lalu tekan Tab dua kali.

Menambahkan snippet dengan surround-with

Dalam contoh cuplikan C++ berikut, pintasan if dapat digunakan sebagai cuplikan penyisipan atau dikelilingi dengan cuplikan. Jika Anda memilih baris return FALSE; kode lalu memilih Kelilingi Dengan>jika, cuplikan diperluas di sekitar baris.

if (true)
{
    return FALSE;
}

Parameter penggantian cuplikan

Cuplikan dapat berisi parameter pengganti, yang merupakan tempat penampung yang harus Anda ganti agar sesuai dengan kode yang Anda tulis. Dalam contoh sebelumnya, true adalah parameter pengganti, yang Anda ganti dengan kondisi yang sesuai. Penggantian diulang untuk setiap instans parameter pengganti tersebut dalam cuplikan.

Misalnya, Visual Basic memiliki cuplikan kode yang menentukan properti. Untuk menyisipkan cuplikan:

  1. Di menu konteks klik kanan dalam file kode Visual Basic, pilih >Cuplikan Sisipkan Cuplikan.
  2. Pilih Properti Pola>Kode, Prosedur, Peristiwa>Tentukan Properti.

Cuplikan layar menu cuplikan kode untuk Tentukan Properti.

Kode berikut disisipkan:

Private newPropertyValue As String
Public Property NewProperty() As String
    Get
        Return newPropertyValue
    End Get
    Set(ByVal value As String)
        newPropertyValue = value
    End Set
End Property

Jika Anda mengubah newPropertyValue ke m_property, setiap instans newPropertyValue perubahan. Jika Anda mengubah String ke Int dalam deklarasi properti, nilai dalam Set metode juga berubah menjadi Int.

Praktik terbaik untuk menggunakan cuplikan kode

Kode dalam cuplikan kode hanya menunjukkan cara paling mendasar untuk melakukan sesuatu. Untuk sebagian besar aplikasi, kode harus dimodifikasi agar sesuai dengan aplikasi.

Penanganan pengecualian

Biasanya, cuplikan kode Try...Catch memblokir menangkap dan menumbuhkan kembali semua pengecualian, tetapi itu mungkin bukan pilihan yang tepat untuk proyek Anda. Untuk setiap pengecualian, ada beberapa cara untuk merespons. Misalnya, lihat Cara menangani pengecualian menggunakan try/catch (C#) dan Coba... Menangkap... Pernyataan terakhir (Visual Basic).

Lokasi File

Saat Anda mengadaptasi lokasi file ke aplikasi Anda, pastikan untuk mempertimbangkan faktor-faktor berikut.

  • Temukan lokasi yang dapat diakses. Pengguna mungkin tidak memiliki akses ke folder Program Files komputer, sehingga menyimpan file pengguna dengan file aplikasi mungkin tidak berfungsi.

  • Temukan lokasi yang aman. Menyimpan file di folder akar seperti C:\ tidak aman. Untuk data aplikasi, yang terbaik adalah menggunakan folder Data Aplikasi. Untuk data pengguna individual, aplikasi dapat membuat file di folder Dokumen setiap pengguna.

  • Gunakan nama file yang valid. Anda dapat menggunakan OpenFileDialog kontrol dan SaveFileDialog untuk mengurangi kemungkinan nama file yang tidak valid.

  • Ketahuilah bahwa file yang dipilih pengguna dapat dihapus sebelum kode Anda dapat memanipulasi file. Selain itu, pengguna mungkin tidak memiliki izin untuk menulis ke file.

Keamanan

Keamanan cuplikan tergantung pada tempat Anda menggunakannya dalam kode sumber dan bagaimana Anda memodifikasinya setelah ada dalam kode. Daftar berikut ini berisi beberapa area yang perlu dipertimbangkan:

  • Akses file dan database
  • Keamanan akses kode
  • Melindungi sumber daya seperti log peristiwa dan registri
  • Penyimpanan rahasia
  • Memverifikasi input
  • Meneruskan data ke teknologi pembuatan skrip

Untuk informasi selengkapnya, lihat Mengamankan aplikasi.

Cuplikan kode yang diunduh

Cuplikan kode yang diinstal oleh Visual Studio bukan bahaya keamanan itu sendiri. Namun, mereka dapat menciptakan risiko keamanan di aplikasi Anda. Cuplikan yang diunduh dari internet harus diperlakukan dengan sangat hati-hati, seperti konten yang diunduh lainnya. Unduh cuplikan hanya dari situs yang Anda percayai, dan gunakan perangkat lunak virus terbaru.

Buka semua file cuplikan yang diunduh di Notepad atau editor XML Visual Studio dan tinjau dengan hati-hati sebelum menginstalnya. Waspadalah terhadap masalah berikut:

  • Kode cuplikan yang dapat merusak sistem Anda jika Anda menjalankannya. Baca kode sumber dengan hati-hati sebelum menjalankannya.

  • HelpURL blok dalam file cuplikan yang berisi URL yang menjalankan file skrip berbahaya atau menampilkan situs web yang menyinggung.

  • Cuplikan yang berisi referensi yang ditambahkan secara diam-diam ke proyek Anda dan dapat dimuat dari mana saja di sistem Anda. Anda dapat mengunduh referensi ini dari lokasi yang sama tempat Anda mengunduh cuplikan. Cuplikan kemudian dapat memanggil metode dalam referensi yang menjalankan kode berbahaya. Untuk mendeteksi referensi tersebut Imports , tinjau blok dan References file cuplikan.

Konten terkait