Jangan biarkan komentar disembunyikan di kode sumber Anda! Baca, cari, dan publikasikan dengan Live Documenter. Dokumentasi untuk .NET menjadi mudah.
Live Documenter adalah rangkaian aplikasi dan pustaka yang memungkinkan penayangan langsung dan pembuatan dokumentasi otomatis dari kode .NET dan file komentar xml. Pelajari apa itu Live Documenter dari beranda kami dan unduh versi terbaru.
Lihat dokumentasi secara langsung dan terkini!
Buat dokumentasi statis yang indah.
Atau gunakan perpustakaan API untuk berintegrasi ke dalam proyek Anda sendiri.
Live Documenter adalah aplikasi desktop, utilitas konsol, dan pustaka API yang dirancang untuk membuat kode .NET dan komentar Anda lebih mudah dibaca dan tersedia. Mari bebaskan mereka dari batasan xml yang ada di kode sumber Anda dan manfaatkan dengan baik!
Mulailah dengan mengunduh versi terbaru dan membaca panduan memulai cepat.
Aplikasi desktop memungkinkan proyek studio visual, solusi atau perpustakaan dibuka dan dokumentasi dihasilkan dari file komentar XML secara langsung. Jika perubahan dilakukan pada basis kode, hal ini akan tercermin dalam aplikasi saat proyek dibangun kembali.
Ini juga menyediakan antarmuka yang bagus untuk mengekspor dokumentasi, membaca dan mencetak.
Aplikasi eksportir berguna untuk mengintegrasikan pembuatan dokumentasi ke dalam proses yang ada; seperti skrip build Anda atau membuat dokumentasi ad-hoc.
DLL yang dapat direferensikan oleh proyek untuk menghasilkan dokumentasi secara otomatis saat runtime. Detail API dan cara menggunakannya dapat ditemukan di dokumentasi.
Ini hanya akan berfungsi di Windows saat ini, pekerjaan sedang berlangsung untuk mentransfer ke netstandard dan membuat semuanya kecuali aplikasi desktop lintas platform di .NET Core.
File zip versi terbaru disediakan. Untuk menginstal, unduh file, unzip dan jalankan dari direktori.
Persyaratan
.NET Inti SDK 3.1
Kode terbaru telah dikerjakan di Visual Studio 2019 dan beberapa proyek telah ditransfer ke perpustakaan netstandard dan menggunakan format file csproj terbaru.
Harap beri tahu saya jika ada masalah yang muncul dari sumbernya sehingga saya dapat menyelesaikannya.
Semua bantuan dihargai. Ada situs dokumentasi terkait yang selalu dapat ditingkatkan.
Jika Anda ingin terlibat dalam proyek ini, silakan lihat isu-isu terkini. Catat minat Anda, dapatkan versi terbaru dan buat permintaan tarik ketika Anda siap untuk menggabungkan perubahan.
Memberikan umpan balik melalui masalah GitHub juga membantu memastikan proyek dibuat lebih stabil dan terus ditingkatkan.