Mendokumentasikan dengan Komentar dartdoc
Menulis dokumentasi yang ditampilkan di pub.dev
Mendokumentasikan dengan Komentar dartdoc adalah pelajaran Dart Academy gratis di CoddyKit. Ini adalah pelajaran 2 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Dart Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Dart Academy mencakup 4 pelajaran total.
Dokumentasi adalah Bagian dari Produk
Paket yang hebat menyediakan dokumentasi yang hebat. Dart mengubah komentar khusus menjadi referensi yang dapat dijelajahi, sehingga dokumentasi merupakan fitur utama, bukan tambahan belaka. 📝
Komentar Dokumentasi Tiga Garis Miring
Komentar dokumentasi diawali dengan tiga garis miring. Komentar dokumentasi ini berada tepat di atas deklarasi dan menjelaskan fungsinya bagi pengguna Anda.
/// Adds two numbers and returns the sum.
int add(int a, int b) => a + b;Awali dengan Satu Baris Ringkasan
Mulailah setiap komentar dokumentasi dengan satu kalimat ringkasan yang singkat. Peralatan menampilkan baris pertama ini dalam daftar, jadi pastikan kalimat tersebut jelas dan lengkap tanpa konteks tambahan.
Markdown Didukung
Komentar dokumentasi menerima Markdown, sehingga Anda dapat menambahkan penekanan, daftar, dan tautan. Halaman hasil render Anda di pub.dev akan terlihat rapi dengan hampir tanpa usaha.
/// Returns the **first** matching item.Tautkan ke Simbol Lain
Apit nama dengan tanda kurung siku untuk membuat tautan silang yang aktif. Pembaca dapat langsung menuju kelas atau metode terkait dalam dokumentasi yang Anda hasilkan.
/// See [add] for the inverse of [subtract].Contoh Kode dalam Blok Berpagar
Tampilkan penggunaan nyata di dalam blok kode berpagar pada komentar Anda. Contoh singkat mengajarkan lebih cepat daripada beberapa paragraf dan meyakinkan pengguna bahwa kode tersebut berfungsi.
Dokumentasikan Setiap Anggota Publik
Usahakan untuk mendokumentasikan setiap kelas, fungsi, dan properti publik. Anggota privat yang diawali garis bawah boleh tidak dijelaskan, tetapi apa pun yang diekspor layak diberi satu kalimat.
Dokumentasi Tingkat Pustaka
Letakkan komentar dokumentasi di atas direktif pustaka untuk menjelaskan seluruh berkas. Komentar pustaka ini menjadi teks pembuka untuk bagian API Anda tersebut.
/// Math helpers for everyday use.
library calc;Hasilkan Situs dengan dartdoc
Jalankan peralatan dartdoc untuk mengubah komentar Anda menjadi situs web statis. pub.dev menjalankannya secara otomatis untuk Anda ketika Anda memublikasikan paket.
dart doc .Cakupan Dokumentasi Mendatangkan Poin
pub.dev memberikan penghargaan kepada paket yang terdokumentasi dengan baik. Cakupan dokumentasi yang lebih tinggi meningkatkan skor Anda dan memberi sinyal kualitas kepada siapa pun yang memilih dependensi. ⭐
Jaga Dokumentasi Tetap Dekat dengan Kode
Karena komentar dokumentasi berada di samping kode, keduanya mudah diperbarui secara bersamaan. Perlakukan dokumentasi yang usang seperti bug dan perbaikilah ketika perilaku berubah.
Pemeriksaan Singkat
Gaya komentar apa yang diperlakukan Dart sebagai komentar dokumentasi?
Ringkasan: Dokumentasi yang Dirender
Sekarang Anda dapat menulis komentar dokumentasi tiga garis miring, menautkan simbol, menambahkan contoh, dan menghasilkan situs dengan dart doc. Dokumentasi yang jelas akan memenangkan pengguna. 🙌
Belajar Dart dengan tutor AI — gratis
Tulis dan jalankan kode asli di browser kamu, dapatkan bantuan instan dari tutor AI 24/7, dan lanjutkan di mana kamu tinggalkan di web atau aplikasi.
- Kursus
- 30
- Pelajaran
- 120
Pertanyaan yang Sering Diajukan
Apakah pelajaran “Mendokumentasikan dengan Komentar dartdoc” gratis?
Ya — teks lengkap “Mendokumentasikan dengan Komentar dartdoc” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Dart Academy, upgrade ke CoddyKit PRO. Kursus Dart Academy mencakup 4 pelajaran total.
Apa yang akan aku pelajari di “Mendokumentasikan dengan Komentar dartdoc”?
Menulis dokumentasi yang ditampilkan di pub.dev Kamu berlatih Dart Academy dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.
Apakah aku perlu pengalaman untuk memulai Dart Academy?
Tidak diperlukan pengalaman sebelumnya. Dart Academy di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 2 dari 4.
Berapa lama pelajaran “Mendokumentasikan dengan Komentar dartdoc” memakan waktu?
Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.
Bisakah aku menulis dan menjalankan kode dalam pelajaran Dart Academy ini?
Ya. Setiap pelajaran Dart Academy menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.
Semua pelajaran dalam kursus ini
- Menyusun Library yang Siap Dipublikasikan
- Mendokumentasikan dengan Komentar dartdoc
- Linting, Pemformatan, dan Skor pana
- dart pub publish ke pub.dev