Dartdoc: dokumen yang dihasilkan untuk plugin flutter juga menyertakan dart: docs

Ini adalah bug dartdocs.org, tetapi jenis bug dartdocs.org apa yang tidak jelas bagi saya.

Dugaan saya adalah ini mungkin ada hubungannya dengan pengiriman flutter SDK mereka sendiri dan dartdocs.org tidak mengecualikan flutter SDK secara eksplisit pada baris perintah (atau salah memasukkannya).

Dimasukkannya dart:ui dalam dokumen yang dihasilkan tampaknya mengkonfirmasi hipotesis ini.

https://www.dartdocs.org/documentation/url_launcher/0.4.1/log.txt

Log menunjukkan dartdoc tidak mengenali bahwa flutter SDK bukan bagian dari paket. Tapi kenapa tidak begitu jelas.

@jcollins-g jika Anda memerlukan repro lokal, langkah-langkah ini berfungsi untuk saya:

git clone https://github.com/flutter/plugins.git
cd plugins/packages/url_launcher/
export FLUTTER_ROOT=<path to where you have flutter>/flutter
dartdoc

Ada berita @jcollins-g?

Saya dapat mereproduksinya dan sedang mengerjakan satu set flag baris perintah untuk Anda gunakan untuk bekerja sementara saya membuat perbaikan yang lebih permanen.

@mit-mit bekerja dengan flag baris perintah berikut:

--exclude dart.collection,dart.math,dart.core,dart.developer,dart.io,dart.ui,dart.isolate,dart.convert,dart.async,dart.typed_data

Ini akan aman digunakan dengan dan tanpa perbaikan nyata untuk masalah ini.

diturunkan ke P2 karena ada solusi, tetapi masih akan mencoba untuk segera memperbaikinya.

Ini tidak lagi diperlukan di kepala; Perhitungan SDK sekarang cukup pintar untuk tidak mencoba memasukkan komponen SDK dalam plugin flutter.

@jcollins-g Apakah ini memperbaiki $ dartdoc mencoba mengurai sejumlah besar file, tidak terkait dengan aplikasi flutter saya?

keluaran.txt

@ jcollins-g Solusi itu tidak berhasil untuk saya. Itu masih mem-parsing sejumlah besar file, yang berada di luar direktori lib/ proyek saya!

Hai @devxpy ,

dartdoc mem-parsing semua file di semua paket yang dapat dijangkau melalui pohon impor-ekspor proyek Anda (masalah ini adalah bahwa terkadang kami berpikir kami perlu mendokumentasikan beberapa di antaranya ketika itu tidak pantas) dan ini adalah perilaku yang diharapkan. Ini perlu dilakukan karena cara makro dartdoc dan pelingkupan referensi komentar bekerja, meskipun mungkin dapat dioptimalkan untuk hanya melakukan ini sesuai permintaan.

Jika itu menghasilkan dokumen untuk hal-hal yang seharusnya tidak terjadi, bug ini atau yang lain akan sesuai untuk dibuka.

meskipun mungkin dapat dioptimalkan untuk hanya melakukan ini sesuai permintaan.

Mekanisme saat ini tidak menyimpan sesuatu?
Karena saat ini mem-parsing semuanya lagi, yang membutuhkan waktu yang sangat lama, untuk aplikasi yang relatif kecil.

@devxpy

Sayangnya, tidak, itu tidak cache dan memang membutuhkan waktu yang sangat lama. Saya memiliki beberapa ide tentang cara meningkatkannya, tetapi kinerja untuk dartdoc belum menjadi prioritas yang cukup tinggi untuk dapat mengalokasikan waktu.

@devxpy Untuk memperluas dengan sangat singkat, caching tidak mudah untuk dartdoc karena perubahan pada file yang tampaknya tidak terkait dapat memengaruhi dokumentasi yang dihasilkan untuk file lain. Ini karena makro lingkup global dan beberapa referensi komentar dapat memiliki serta kanonikalisasi antarmuka publik dartdoc. Sebuah desain untuk memperbaikinya akan memiliki beberapa heuristik untuk menghilangkan masalah tersebut dalam kasus umum, atau kami dapat mengubah beberapa aturan pelingkupan kami dan kemudian mengadopsi strategi server analisis dari pembatalan yang ditargetkan ketika perubahan terdeteksi. Bukan jumlah pekerjaan yang sepele dalam kedua kasus (meskipun tentu saja bukan tidak mungkin)

Terima kasih atas penjelasan detailnya!

@jcollins-g Apakah kompiler "hot-reload" berbasis pengamat file membutuhkan upaya yang sama?

@devxpy Memang, saya akan mengatakan lebih banyak usaha. Ada tim yang melakukan hal seperti itu di https://github.com/dart-lang/build , dan Flutter tentu saja memiliki dukungan pemuatan ulang yang panas.