rustdoc - Online di Cloud

PROGRAM:

NAMA

rustdoc - menghasilkan dokumentasi dari kode sumber Rust

RINGKASAN

karatdoc [PILIHAN] INPUT

DESKRIPSI

Alat ini menghasilkan dokumentasi referensi API dengan mengekstraksi komentar dari kode sumber
ditulis dalam bahasa Rust, tersedia di https://www.rust-lang.org⟩. Ia menerima
beberapa format input dan menyediakan beberapa format output untuk dokumentasi yang dihasilkan.

PILIHAN

-r, --Masukkan format FORMAT
html atau json (default: disimpulkan)

-w, --format output FORMAT
html atau json (default: html)

-o, --keluaran KELUARAN
di mana menempatkan output (default: dokter/ untuk html, doc.json untuk json)

--pass DAFTAR
daftar pass yang dipisahkan spasi untuk dijalankan (default: '')

--tanpa-default
jangan jalankan pass default

--plugin DAFTAR
daftar plugin yang dipisahkan oleh spasi untuk dijalankan (default: '')

--jalur plugin DIR
direktori untuk memuat plugin dari (default: /tmp/rustdoc_ng/plugins)

--target TRIPLE
target tiga kali lipat untuk didokumentasikan

--nama-peti NAMA
tentukan nama peti ini

-L, --jalur perpustakaan DIR
direktori untuk ditambahkan ke jalur pencarian peti

--cfg SPEC
lulus a --cfg untuk berkarat

--eksternal VAL
lulus --eksternal untuk berkarat

--tes jalankan contoh kode sebagai tes

--tes-argumen ARGS
berikan argumen ke test runner

--html-dalam-header FILE
file untuk ditambahkan ke

--html-sebelum-konten FILE
file untuk ditambahkan , sebelum konten

--html-setelah-konten FILE
file untuk ditambahkan , setelah konten

--penurunan harga-css FILE
File CSS untuk disertakan melalui dalam file penurunan harga yang diberikan

--penurunan harga-taman bermain-url URL
URL untuk mengirim cuplikan kode ke

--penurunan harga-tidak-toc
tidak termasuk daftar isi

-h, --membantu
Bantuan cetak

-V, --Versi: kapan
Cetak versi rustdoc

KELUARAN FORMAT

Alat rustdoc dapat menghasilkan output dalam format HTML atau JSON.

Jika menggunakan format HTML, maka tujuan keluaran yang ditentukan adalah direktori root
struktur HTML untuk semua dokumentasi. Halaman akan ditempatkan ke direktori ini,
dan file sumber juga mungkin akan dirender ke dalamnya.

Jika menggunakan format JSON, maka tujuan keluaran yang ditentukan akan memiliki keluaran rustdoc
serial sebagai JSON ke dalamnya. Format keluaran ini ada untuk pra-kompilasi dokumentasi untuk:
peti, dan untuk penggunaan di alat non-rustdoc. Output JSON adalah hash berikut:

{
"skema": VERSI,
"peti": ...,
"plugin": ...,
}

Versi skema menunjukkan seperti apa struktur peti/plugin. Dalam
versi skema strukturnya akan tetap sama. NS peti bidang akan berisi semua
dokumentasi yang relevan untuk sumber yang didokumentasikan, dan plugin bidang akan berisi
output dari plugin berjalan di atas peti.

CONTOH

Untuk menghasilkan dokumentasi untuk sumber di direktori saat ini:
$rustdoc hello.rs

Daftar semua pass yang tersedia yang dimiliki rustdoc, bersama dengan pass default:
$rustdoc --melewati daftar

Untuk mengkompilasi dokumentasi untuk peti, dan kemudian menggunakannya untuk merender html di lain waktu
tanggal:
$rustdoc -w json halo.rs
$rustdoc doc.json

HTML yang dihasilkan dapat dilihat dengan browser web standar apa pun.

Gunakan rustdoc online menggunakan layanan onworks.net