Coding & data · Dengan contoh
Docstring dan komentar yang menjelaskan alasan
Beri contoh komentar yang buruk dan yang baik, lalu AI menulis docstring dan komentar untuk kodemu dengan pola yang sama tanpa mengubah logikanya.
Prompt siap salin
- Prompt
Tambahkan docstring dan komentar ke kode {{bahasa pemrograman}} berikut dengan gaya {{Google style / NumPy style / JSDoc}}. Ikuti pola contoh ini. Contoh komentar yang buruk (mengulang isi kode): # tambah 1 ke i i = i + 1 Contoh komentar yang baik (menjelaskan alasan): # Nomor urut di laporan dimulai dari 1, sedangkan indeks list dari 0. i = i + 1 Contoh docstring yang baik: def hitung_denda(hari_telat: int) -> int: """Hitung denda keterlambatan buku perpustakaan. Args: hari_telat: jumlah hari lewat dari tanggal kembali; 0 atau negatif berarti tidak telat. Returns: Denda dalam rupiah, Rp1.000 per hari, paling banyak Rp30.000. """ Kode saya (kunci API dan data pribadi sudah dihapus): --- kode mulai --- {{tempel kode}} --- kode selesai --- Konteks yang tidak terlihat dari kode: {{misalnya alasan angka tertentu, aturan bisnis, siapa yang memanggil fungsi ini}} Aturan: satu docstring per fungsi publik yang menjelaskan tujuan, parameter, nilai kembali, dan error yang mungkin dilempar; komentar baris hanya untuk alasan yang tidak terlihat dari kode. Jangan mengubah logika, nama, atau urutan baris. Jangan mengarang alasan bisnis; bila alasan sebuah angka atau syarat tidak bisa disimpulkan, tulis komentar "TODO: tanyakan alasan ..." dan sebutkan di akhir jawaban.
Isian yang harus kamu ganti, termasuk tanda {{ }}
- bahasa pemrograman
- Google style / NumPy style / JSDoc
- tempel kode
- misalnya alasan angka tertentu, aturan bisnis, siapa yang memanggil fungsi ini
Bedah prompt
Kenapa ini bekerja
Contoh komentar yang buruk (mengulang isi kode)
Tanpa contoh buruk, AI cenderung menulis komentar yang hanya menerjemahkan kode ke bahasa manusia dan tidak menambah informasi.komentar baris hanya untuk alasan yang tidak terlihat dari kode
Alasan di balik angka atau syarat adalah hal yang hilang saat penulis kode pindah, dan itu yang dicari pembaca berikutnya.Jangan mengubah logika, nama, atau urutan baris.
Tugas dokumentasi yang ikut mengubah kode bisa memasukkan bug tanpa disadari, karena perhatianmu tertuju pada komentarnya.TODO: tanyakan alasan
Penanda TODO jujur menunjukkan bagian yang belum dipahami, alih-alih alasan karangan yang menyesatkan pembaca berikutnya.
Kalau jawabannya belum pas
Kirim di percakapan yang sama. Perintah yang spesifik jauh lebih efektif daripada “perbaiki lagi”.
Komentarnya masih terlalu ramai
Hapus komentar yang hanya mengulang isi kode dan pertahankan yang menjelaskan alasan. Tampilkan daftar komentar yang dihapus supaya bisa saya periksa.
Sesuaikan sebelum dipakai
- Prompt ini templat, bukan jawaban. Ubah peran, konteks, dan formatnya sesuai situasimu.
- AI bisa salah dan bisa mengarang fakta, angka, atau sitasi dengan yakin. Periksa ulang semua hasil.
- Ikuti aturan kampus, sekolah, atau kantormu tentang AI; untuk tugas akademik, cantumkan penggunaannya bila diminta.
- Jangan menempelkan data pribadi, data pelanggan, atau dokumen rahasia.
Bentuk Dengan contoh: Contoh yang buruk dan yang baik (few-shot) disertakan supaya AI meniru polanya. Prompt lain berbentuk ini.
Kelas terkait
- Dokumentasi Teknis: Panduan Pengguna dan ProsedurPembaca dan jenis dokumen, prasyarat, langkah bernomor, hasil langkah, placeholder, catatan dan peringatan, troubleshooting, serta konsistensi istilah. Kelas ini menguji penerapan aturan tertulis pedoman gaya, bukan kemampuan menulis dokumen bebas.
- Python dari NolVariabel, teks, kondisi, perulangan, dict, dan penanganan error — ditulis dan diuji langsung di browser.
Prompt lain di Coding & data Semua
- Jelaskan pesan error dan cari penyebabnyaIsian formulir · Isi formulir bahasa, perintah, pesan error lengkap, dan kode terkait, lalu dapat arti error, dugaan penyebab, dan cara membuktikannya.
- Query SQL dari pertanyaan bisnisPercakapan bertahap · Tempel skema tabel sekali, pastikan AI memahaminya, lalu ajukan pertanyaan satu per satu dan dapat query beserta penjelasannya.
- Regex dari contoh yang cocok dan tidakDengan contoh · Daftar teks yang harus cocok dan yang harus ditolak jadi soal latihan bagi AI, lalu regex-nya diuji terhadap setiap contoh.
- Pesan commit dan deskripsi pull requestDua fase · Fase 1 meringkas diff dan memeriksa apakah perlu dipecah; fase 2 menulis pesan commit dan deskripsi PR dari ringkasan yang kamu setujui.

