זוהי הפקודה naturaldocs שניתן להריץ בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות החינמיות שלנו כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS.
תָכְנִית:
שֵׁם
NaturalDocs - מחולל תיעוד רב-לשוני וניתן להרחבה
תַקצִיר
דוקטורים טבעיים -אֲנִי [-אֲנִי ...] -o
פורמט> [-o ...] -פ
ספרייה> [אפשרויות]
תיאור
דף מדריך זה מתעד בקצרה את הפקודה .B naturaldocs. שימו לב ש דוקטורים טבעיים הוא
סקריפט עטיפה שבדביאן מפעיל את הקוד האמיתי מסמכים טבעיים תוכנית פרל. אז, האמיתי,
השם המקורי של התוכנה הוא NaturalDocs אבל במערכות דביאן אתה מפעיל אותה כ-
מסמכים טבעיים.
טבעי Docs זהו מחולל תיעוד רב-לשוני, הניתן להרחבה ובקוד פתוח. אתה
תעד את הקוד שלך בתחביר טבעי שנקרא כמו אנגלית פשוטה. מסמכים טבעיים לאחר מכן
סורק את הקוד שלך ובונה ממנו תיעוד HTML באיכות גבוהה.
אפשרויות
סיכום אפשרויות, שחולץ מהעזרה שהודפסה על ידי -h המתג כלול למטה.
לתיאור מלא של אופן הפעולה של NaturalDocs, עיינו בקבצי הטקסט ב...
ספריית /usr/share/doc/naturaldocs.
דרוש פרמטרים:
-אני, --קֶלֶט, --מָקוֹר DIR
מציין ספריית קלט (מקור). נדרש.
ניתן לציין מספר פעמים.
-או, --תְפוּקָה FMT DIR
מציין פורמט פלט וספרייה. נדרש.
ניתן לציין מספר פעמים, אך רק פעם אחת בכל ספרייה. פלט אפשרי
הפורמטים הם HTML ו-FramedHTML.
-פ, --פּרוֹיֶקט DIR
מציין את ספריית הפרויקט. נדרש.
צריכה להיות ספריית פרויקטים ייחודית לכל ספריית מקור.
אופציונלי פרמטרים:
-ס, --סִגְנוֹן סגנון [סִגְנוֹן ...]
מציין את סגנון ה-CSS בעת בניית פלט HTML. אם קיימים מספר סגנונות
שצוין, כולם ייכללו בסדר שניתן.
תמונה, --תמונה DIR
מציין ספריית תמונות. ניתן לציין מספר פעמים. התחל עם * ל
ציין ספרייה יחסית, כמו ב- -img */images.
-לַעֲשׂוֹת, --מתועד-בלבד
מציין שרק היבטי קוד מתועדים צריכים להיכלל בפלט.
-ט, --אורך-טאב רק
מציין את מספר הרווחים שאליהם יש להרחיב את הטאבים. זה רק צריך להיות
מוגדר אם אתה משתמש בטאבים בקוד לדוגמה ובדיאגרמות טקסט. ברירת המחדל היא 4.
-xi, --הדרה-קלט, --exclude-source
אינו כולל ספריית קלט (מקור) בתיעוד. בוצע אוטומטית עבור
ספריות הפרויקט והפלט. ניתן לציין זאת מספר פעמים.
-לְנַדְנֵד, --ללא קיבוץ אוטומטי
מכבה לחלוטין את הקיבוץ האוטומטי.
-לְעִתִים קְרוֹבוֹת, --רק-כותרות-קבצים
קבצי המקור ישתמשו רק בשם הקובץ ככותרת.
-ר, --לִבנוֹת מִחָדָשׁ
בונה מחדש את כל קבצי הפלט והנתונים מאפס. לא משפיע על קובץ התפריט.
-רו, --בנייה-משוחזרת-פלט
בונה מחדש את כל קבצי הפלט מאפס.
-q, --שֶׁקֶט
מדכא את כל הפלט שאינו שגיאה.
-?, -ח, - עזרה
מציג הפניה לתחביר.
השתמש ב- naturaldocs באינטרנט באמצעות שירותי onworks.net