Dartdoc: Tambahkan opsi untuk menghasilkan dokumentasi untuk kelas privat

Ini seperti yang dirancang. Namun, kami dapat menambahkan opsi untuk mendokumentasikannya.

@sathishmscict Apakah Anda mengacu pada pengidentifikasi yang dimulai dengan garis bawah (_) atau pengidentifikasi yang bukan export -ed dari perpustakaan (yaitu biasanya hanya digunakan dalam /lib/src)?

Saya tertarik untuk mendokumentasikan apa pun di perpustakaan yang tidak secara eksplisit diekspor sebagai bagian dari API-nya!

Saya juga tertarik pada kemampuan untuk menghasilkan dokumen untuk semua kelas, termasuk kelas privat.

Saya memiliki kelas pribadi yang diinisialisasi di dalam kelas lain (yang diekspor/publik) untuk memastikan bahwa mereka tidak dapat menginisialisasi di luar kelas sehingga tidak mencemari intellisense, tetapi saya ingin mereka dapat membaca dokumentasi di fungsi internal untuk kelas itu.

Di Flutter kami memiliki widget stateful, di mana kelas publik biasanya kecil dan tidak menarik, dengan semua logika di kelas State dengan nama pribadi. Kelas-kelas Negara Bagian ini menuntut pendokumentasian!

Ada pembaruan tentang ini? Apakah ada opsi untuk mendokumentasikan kelas privat juga?

Belum ada pembaruan, tetapi karena lalu lintas terus berlanjut pada permintaan fitur ini, naik ke P2.

Kedengarannya seperti tren umum adalah menginginkan dokumentasi untuk semua anggota perpustakaan pribadi di perpustakaan atau bahkan paket.

Jika itu akan berada di tingkat perpustakaan atau paket, saya mungkin akan condong ke file daftar parameter dartdoc_options dan/atau mengaktifkan seluruh paket. Tidak terlalu halus, tetapi salah satu dari dua opsi itu akan menyelesaikan pekerjaan dalam banyak kasus. Jika tidak, anotasi package:meta -- sesuatu seperti @visibleInDocumentation -- akan menjadi cara yang tepat, mirip dengan @visibleForTesting . Salah satu kelemahan dari pendekatan itu adalah Anda harus menandai simbol non-publik apa pun dengan tag itu agar dapat muncul. Ada pikiran?

@visibleInDocumentation tampaknya merupakan taruhan terbaik di sini- karena itu juga memberikan opsi untuk mendokumentasikan anggota pribadi tertentu sambil menjaga orang lain sepenuhnya pribadi.

Semua ini bisa dilakukan, di mana yang lebih spesifik mengesampingkan yang lebih umum. Dalam kasus flutter, saya ingin mendokumentasikan paket saya sendiri, dan tidak semua paket, sehingga tingkat paket cocok untuk saya.

Karena anotasi dapat hadir di perpustakaan, jika kita melakukan keduanya mungkin versi dartdoc_options akan dibatasi untuk seluruh paket atau pohon direktori.

Ini juga saat yang tepat untuk menghentikan direktif dartdoc @nodoc kuno yang harus disematkan dengan komentar dokumentasi dan menggantinya dengan anotasi lain.

Opsi untuk menyertakan kelas privat ( _Foo ) penting untuk mendokumentasikan aplikasi flutter karena jika tidak, Anda tidak dapat mendokumentasikan StatefulWidget s

ya akan sangat bagus jika kita bisa mendokumentasikan statefulwidgets juga. Jika ada yang bisa menunjukkan di mana logging kelas privat dapat diaktifkan, saya ingin membuat garpu dan menggunakannya sementara itu