Lompat ke konten utama

Ajak teman, raih Rp1.000.000. Ikut kompetisi

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.

1 kali kirim4 isianDiperbarui Untuk: Programmer pemula, mahasiswa, dan analis yang menulis skrip Python atau JavaScript untuk dipakai orang lain.

Prompt siap salin

  1. 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

  1. 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.
  2. komentar baris hanya untuk alasan yang tidak terlihat dari kodeAlasan di balik angka atau syarat adalah hal yang hilang saat penulis kode pindah, dan itu yang dicari pembaca berikutnya.
  3. Jangan mengubah logika, nama, atau urutan baris.Tugas dokumentasi yang ikut mengubah kode bisa memasukkan bug tanpa disadari, karena perhatianmu tertuju pada komentarnya.
  4. TODO: tanyakan alasanPenanda 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.

© 2026 KelasGratis. Seluruh hak cipta dilindungi undang-undang. Dilarang scraping, kecuali perayap mesin pencari dan AI untuk pengindeksan. Syarat & hak cipta · Dari pendiri yang sama: iLingo, GrowWithAI dan Ambis.