rustdoc - آنلاین در ابر

برنامه:

نام

rustdoc - مستندات را از کد منبع Rust ایجاد کنید

خلاصه

rustdoc [OPTIONS] INPUT

شرح

این ابزار مستندات مرجع API را با استخراج نظرات از کد منبع تولید می کند
نوشته شده به زبان Rust، موجود در ⟨https://www.rust-lang.org⟩. می پذیرد
چندین فرمت ورودی و چندین فرمت خروجی برای مستندات تولید شده فراهم می کند.

OPTIONS

-r, --input-format FORMAT
html یا json (پیش‌فرض: استنباط شده)

-w, --فرمت خروجی FORMAT
html یا json (پیش‌فرض: html)

-o, -- خروجی OUTPUT
محل قرار دادن خروجی (پیش فرض: سند/ برای html doc.json برای json)

-- پاس می دهد لیست
لیستی از گذرنامه‌های اجرا شده با فاصله (پیش‌فرض: '')

-- بدون پیش فرض
پاس های پیش فرض را اجرا نکنید

-- پلاگین ها لیست
لیستی از پلاگین‌ها برای اجرا با فاصله (پیش‌فرض: '')

---plugin-path DIR
دایرکتوری برای بارگیری افزونه ها از (پیش فرض: /tmp/rustdoc_ng/plugins)

--هدف سه گانه
هدف سه گانه به سند

--جعبه-نام نام
نام این جعبه را مشخص کنید

-L, --کتابخانه-مسیر DIR
دایرکتوری برای افزودن به مسیر جستجوی جعبه

--cfg SPEC
عبور یک --cfg به زنگ زدن

--خارجی VAL
عبور یک --خارجی به زنگ زدن

--تست نمونه های کد را به عنوان آزمایش اجرا کنید

--test-args ARGS
آرگومان ها را به اجراکننده آزمایش ارسال کنید

--html-in-header فایل
فایل برای اضافه کردن

--html-قبل از محتوا فایل
فایل برای اضافه کردن ، قبل از محتوا

--html-after-content فایل
فایل برای اضافه کردن ، پس از محتوا

--markdown-css فایل
فایل های CSS برای اضافه کردن از طریق در یک فایل Markdown رندر شده

--markdown-playground-url URL
URL برای ارسال قطعه کد به

--markdown-no-toc
فهرست مطالب را درج نکنید

-h, --کمک
راهنمای چاپ

-V, - نسخه
نسخه rustdoc را چاپ کنید

OUTPUT فرمها

ابزار rustdoc می تواند خروجی را در قالب HTML یا JSON تولید کند.

اگر از فرمت HTML استفاده می کنید، مقصد خروجی مشخص شده دایرکتوری ریشه خواهد بود
یک ساختار HTML برای تمام اسناد. صفحات در این دایرکتوری قرار خواهند گرفت،
و فایل های منبع نیز احتمالاً در آن رندر می شوند.

در صورت استفاده از فرمت JSON، مقصد خروجی مشخص شده دارای خروجی rustdoc خواهد بود
به عنوان JSON در آن سریال شده است. این فرمت خروجی برای پیش کامپایل کردن اسناد وجود دارد
جعبه ها و برای استفاده در ابزارهای غیر زنگ زدگی. خروجی JSON هش زیر است:

{
"schema": VERSION،
"جعبه": ...،
"پلاگین": ...،
}

نسخه طرحواره نشان می دهد که ساختار جعبه/افزونه ها چگونه خواهد بود. در یک
نسخه طرحواره ساختار یکسان باقی خواهد ماند. در جعبه فیلد شامل همه خواهد بود
اسناد مربوط به منبعی که مستند شده است و پلاگین ها فیلد شامل خواهد شد
خروجی پلاگین ها روی جعبه اجرا می شود.

مثال ها

برای ایجاد مستندات برای منبع در دایرکتوری فعلی:
$ rustdoc hello.rs

لیست تمام پاس های موجود که rustdoc دارد، همراه با پاس های پیش فرض:
لیست $ rustdoc -- passes

برای از پیش کامپایل کردن اسناد برای یک جعبه، و سپس استفاده از آن برای رندر html در بعد
تاریخ:
$ rustdoc -w json hello.rs
$ rustdoc doc.json

HTML تولید شده را می توان با هر مرورگر وب استاندارد مشاهده کرد.

با استفاده از خدمات onworks.net از rustdoc به صورت آنلاین استفاده کنید