rustdoc - מקוון בענן

תָכְנִית:

שֵׁם

rustdoc - הפקת תיעוד מקוד מקור Rust

תַקצִיר

rustdoc [אפשרויות] קלט

תיאור

כלי זה יוצר תיעוד התייחסות ל-API על ידי חילוץ הערות מקוד המקור
כתוב בשפת Rust, זמין בכתובת ⟨https://www.rust-lang.org⟩. זה מקבל
מספר פורמטי קלט ומספק מספר פורמטי פלט עבור התיעוד שנוצר.

אפשרויות

-r, --פורמט הכנסה פורמט
html או json (ברירת מחדל: משוער)

-w, --פורמט פלט פורמט
html או json (ברירת מחדל: html)

-o, --תְפוּקָה תפוקה
היכן למקם את הפלט (ברירת מחדל: דוק/ עבור html, doc.json עבור json)

--עובר רשימה
רשימה מופרדת ברווחים של מעברים להפעלה (ברירת מחדל: '')

--ללא ברירת מחדל
אל תפעיל את אישורי ברירת המחדל

--תוספים רשימה
רשימה מופרדת ברווחים של תוספים להפעלה (ברירת מחדל: '')

--plugin-path DIR
ספרייה לטעינת תוספים ממנה (ברירת מחדל: /tmp/rustdoc_ng/plugins)

--יַעַד לְשַׁלֵשׁ
מטרה משולשת למסמך

--שם-ארגז שֵׁם
ציין את שם הארגז הזה

-L, --שביל-ספרייה DIR
ספרייה להוספה לנתיב החיפוש של הארגז

--cfg SPEC
לעבור א --cfg להחליד

-- חיצוני מדד
לעבור -- חיצוני להחליד

--מִבְחָן הרץ דוגמאות קוד כבדיקות

--test-args ARGS
להעביר טיעונים לרץ המבחן

--html-in-header קובץ
קובץ להוסיף אליו

--html-before-content קובץ
קובץ להוספה , לפני התוכן

--html-אחרי-תוכן קובץ
קובץ להוספה , אחרי תוכן

--markdown-css קובץ
קבצי CSS לכלול באמצעות בקובץ Markdown מעובד

--markdown-playground-url כתובת האתר
כתובת URL לשלוח אליה קטעי קוד

--markdown-no-toc
לא לכלול תוכן עניינים

-h, - עזרה
הדפס עזרה

-V, --גִרְסָה
הדפס את הגרסה של rustdoc

תפוקה פורמטים

הכלי rustdoc יכול ליצור פלט בפורמט HTML או JSON.

אם משתמשים בפורמט HTML, יעד הפלט שצוין יהיה ספריית השורש
של מבנה HTML עבור כל התיעוד. דפים יוכנסו לספרייה זו,
וייתכן שגם קבצי מקור יעובדו בו.

אם משתמשים בפורמט JSON, יעד הפלט שצוין יקבל את הפלט rustdoc
מסודרת בתור JSON לתוכו. פורמט פלט זה קיים כדי להרכיב עבורו תיעוד מראש
ארגזים, ולשימוש בכלים שאינם Rustdoc. הפלט של JSON הוא ה-hash הבא:

{
"סכמה": VERSION,
"ארגז": ...,
"תוספים": ...,
}

גרסת הסכימה מציינת כיצד ייראה מבנה הארגז/תוספים. בתוך א
גרסת הסכימה המבנה יישאר זהה. ה ארגז השדה יכיל הכל
תיעוד רלוונטי עבור המקור המתועד, וה תוספים השדה יכיל
הפלט של התוספים עובר על הארגז.

דוגמאות

כדי ליצור תיעוד עבור המקור בספרייה הנוכחית:
$ rustdoc hello.rs

רשום את כל הכרטיסים הזמינים שיש ל-rustdoc, יחד עם אישורי ברירת המחדל:
$ rustdoc --passes רשימה

כדי להרכיב מראש את התיעוד עבור ארגז, ולאחר מכן להשתמש בו לעיבוד HTML מאוחר יותר
תַאֲרִיך:
$ rustdoc -w json hello.rs
$ rustdoc doc.json

ניתן לראות את ה-HTML שנוצר בכל דפדפן אינטרנט רגיל.

השתמש ב-rustdoc באינטרנט באמצעות שירותי onworks.net