Tinjau fitur "jelaskan" dan "mendokumentasikan" GitHub Copilot

  • 5 menit

GitHub Copilot memudahkan pengembang untuk bekerja dengan kode yang kompleks atau tidak dikenal. Dalam Visual Studio Code, pengembang memiliki akses langsung ke fitur GitHub Copilot yang menganalisis, menjelaskan, atau kode dokumen.

Menganalisis dan menjelaskan kode menggunakan GitHub Copilot

Fitur GitHub Copilot berikut dapat digunakan untuk menganalisis dan menjelaskan kode:

  • Mode tanya: Gunakan tampilan Obrolan dalam mode tanya untuk menganalisis seluruh ruang kerja Anda dan mengajukan pertanyaan tentang topik pengkodian, konsep teknologi, dan praktik pemrograman umum.

  • Obrolan Sebaris: Mulai sesi obrolan sebaris langsung dari editor untuk menanyakan tentang bagian kode tertentu.

  • Tindakan Cerdas: Jalankan tindakan Jelaskan cerdas untuk menjelaskan kode yang dipilih tanpa harus menulis perintah.

  • Obrolan Cepat: Ajukan pertanyaan singkat dan kembali ke apa yang Anda lakukan.

Membuat dokumentasi kode sebaris menggunakan GitHub Copilot

Fitur GitHub Copilot berikut dapat digunakan untuk menghasilkan dokumentasi kode sebaris:

  • Mode tanya: Gunakan mode Minta agen untuk menyarankan dokumentasi kode sebaris untuk file kode, kelas, atau metode. Tinjau dokumentasi inline yang disarankan pada tampilan Obrolan. Minta pembaruan sesuai kebutuhan dalam percakapan obrolan. Setelah puas dengan dokumentasi yang diusulkan, Anda dapat menyisipkan dokumentasi yang disarankan ke dalam file kode yang sesuai.

  • Mode rencana: Gunakan mode Rencana untuk membuat rencana implementasi terperinci untuk tugas dokumentasi Anda. Mode Rencana dapat digunakan untuk menganalisis basis kode, mengidentifikasi persyaratan dokumentasi, dan menghasilkan rencana langkah demi langkah. Setelah rencana disetujui, Anda dapat menyerahkannya ke mode agen untuk dieksekusi.

  • Mode agen: Gunakan mode Agen untuk secara otonom menghasilkan dokumentasi kode sebaris untuk proyek kode, file, kelas, atau metode tertentu. Minta agen melakukan tugas lain selama atau setelah proses dokumentasi. Terima atau tolak pembaruan ketika agen telah menyelesaikan tugas yang ditetapkan.

  • Obrolan sebaris - Gunakan sesi obrolan sebaris untuk bekerja langsung di editor kode. Obrolan sebaris berguna ketika Anda ingin mendokumen kode tertentu (kelas, metode, atau blok kode) tanpa meninggalkan editor. Anda dapat memberikan instruksi khusus dalam perintah atau menggunakan /doc perintah garis miring tanpa informasi tertentu jika Anda mau. Pembaruan ditampilkan di editor kode dan dapat diterima atau ditolak. Anda juga dapat memilih opsi untuk menjalankan ulang perintah dengan atau tanpa pembaruan.

  • Gunakan tindakan pintar "Generate Docs" untuk menghasilkan dokumentasi kode sebaris untuk kelas, metode, atau blok kode yang dipilih. Tindakan pintar Buat Dokumen berguna ketika Anda tidak memiliki persyaratan khusus yang akan memerlukan permintaan. Pembaruan ditampilkan di editor kode dan dapat diterima atau ditolak. Anda juga dapat menjalankan ulang tindakan cerdas.

Buat dokumentasi proyek menggunakan GitHub Copilot

Fitur GitHub Copilot berikut dapat digunakan untuk menghasilkan dokumentasi proyek:

  • Tampilan obrolan dalam mode Minta agen: Gunakan agen Minta untuk menganalisis basis kode dan mendapatkan pemahaman tentang proyek kode, file, dan kelas. Agen Ask dapat digunakan untuk mempratinjau dokumentasi proyek yang disarankan. Tinjau saran dan minta pembaruan atau detail lain sesuai kebutuhan. Sisipkan dokumentasi yang disarankan ke dalam file dokumentasi proyek (README.md).

  • Tampilan obrolan dalam mode agen Plan: Buat rencana implementasi terperinci untuk dokumentasi proyek, kemudian alihkan ke mode agen untuk pelaksanaan.

  • Tampilan obrolan dalam mode Agen: Membuat kumpulan file dokumentasi proyek: membuat/memperbarui README.md, membuat/memperbarui UsageExamples.md, dan membuat/memperbarui ChangeLog.md. Sertakan tautan antara file dokumentasi, kelas dan metode referensi silang, dan pastikan konsistensi di seluruh dokumen.

Penting

Saat Anda menggunakan antarmuka Chat dalam mode agen, setiap prompt yang Anda masukkan dihitung sebagai satu permintaan premium, dikalikan dengan faktor pengganda model. GitHub Copilot mungkin mengambil beberapa tindakan tindak lanjut untuk menyelesaikan tugas Anda, tetapi tindakan tindak lanjut ini tidak dihitung terhadap penggunaan permintaan premium Anda. Hanya perintah yang Anda masukkan yang ditagih. Total permintaan premium yang digunakan tergantung pada berapa banyak perintah yang Anda masukkan dan model yang dipilih. Paket Gratis untuk GitHub Copilot mendapatkan 50 permintaan premium per bulan. Periksa deskripsi paket untuk detail selengkapnya tentang batas permintaan premium untuk setiap langganan GitHub Copilot.

Ringkasan

GitHub Copilot membantu Anda menganalisis dan mendokumen kode Anda dengan cepat dan akurat. Tampilan obrolan, obrolan sebaris, obrolan cepat, dan fitur tindakan cerdas menyediakan berbagai tingkat interaksi langsung dalam lingkungan Visual Studio Code.