نام (NAME)

rustdoc - تولید مستندات از کد منبع Rust

خلاصه دستور (SYNOPSIS)

rustdoc [OPTIONS] INPUT

توضیحات (DESCRIPTION)

این ابزار با استخراج کامنت‌ها از کد منبع نوشته‌شده به زبان Rust (موجود در https://www.rust-lang.org)، مستندات مرجع API را تولید می‌کند. این ابزار چندین قالب ورودی را می‌پذیرد و قالب‌های خروجی گوناگونی را برای مستندات تولیدشده ارائه می‌دهد.

گزینه‌ها (OPTIONS)

-r, --input-format FORMAT: rust
-w, --output-format FORMAT: html
-o, --output OUTPUT,: محل قرارگیری خروجی (پیش‌فرض: doc/ برای html)
--passes LIST: فهرستی از گذرهای جداشده با فاصله برای اجرا (پیش‌فرض: '')
--no-defaults: گذرهای پیش‌فرض اجرا نشوند
--plugins LIST: فهرستی از افزونه‌های جداشده با فاصله برای اجرا (پیش‌فرض: '')
--plugin-path DIR: دایرکتوری بارگذاری افزونه‌ها (پیش‌فرض: /tmp/rustdoc_ng/plugins)
--target TRIPLE: سه‌گانه هدف (target triple) برای مستندسازی
--crate-name NAME: مشخص کردن نام این crate
-L, --library-path DIR: دایرکتوری برای افزودن به مسیر جستجوی crate
--cfg SPEC: ارسال یک --cfg به rustc
--extern VAL: ارسال یک --extern به rustc
--test: اجرای مثال‌های کد به عنوان آزمون
--test-args ARGS: ارسال آرگومان‌ها به اجراکننده آزمون
--html-in-header FILE: فایلی برای افزودن به <head>
--html-before-content FILES: فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین <body> و محتوای یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
--markdown-before-content FILES: فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین <body> و محتوای یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
--html-after-content FILES: فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین محتوا و </body> یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
--markdown-after-content FILES: فایل‌هایی برای قرارگیری به‌صورت درون‌خطی بین محتوا و </body> یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
--markdown-css FILES: فایل‌های CSS برای گنجاندن از طریق <link> در یک فایل Markdown پردازش‌شده یا مستندات تولیدشده
--markdown-playground-url URL: نشانی URL برای ارسال قطعه‌کدها به آن
--markdown-no-toc: فهرست مطالب گنجانده نشود
-h, --extend-css: بازتعریف برخی قوانین css با یک فایل مشخص جهت تولید مستندات با پوسته سفارشی
-V, --version: چاپ نسخه rustdoc

قالب‌های خروجی (OUTPUT FORMATS)

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

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

مثال‌ها (EXAMPLES)

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

فهرست کردن تمام گذرهای دردسترس در rustdoc، به همراه گذرهای پیش‌فرض:
$ rustdoc --passes list

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

همچنین ببینید (SEE ALSO)

rustc(1)

گزارش باگ‌ها (BUGS)

برای گزارش اشکالات به https://github.com/rust-lang/rust/issues مراجعه کنید.

نویسندگان (AUTHORS)

تاریخچه کنترل نسخه یا https://thanks.rust-lang.org را ببینید.

کپی‌رایت و تکثیر (COPYRIGHT)

این اثر تحت شرایط مجوز دوگانه Apache 2.0 و MIT قرار دارد. فایل COPYRIGHT را در توزیع منبع rust مشاهده کنید.