godoc - מקוון בענן

תָכְנִית:

שֵׁם

godoc - מחלץ ומייצר תיעוד עבור תוכניות Go

תַקצִיר

godoc [דגל] פקודה [ שם ... ]

תיאור

Godoc מחלץ ומייצר תיעוד עבור תוכניות Go.

יש לו שני מצבים.

ללא הדגל -http, הוא פועל במצב שורת פקודה ומדפיס תיעוד טקסט רגיל
לפלט ויציאות סטנדרטיים. אם גם חבילת ספרייה וגם פקודה באותו שם
קיים, שימוש בקידומת cmd/ יאלץ תיעוד על הפקודה ולא על
חבילת ספרייה. אם צוין דגל -src, godoc מדפיס את הממשק המיוצא של a
חבילה בצורת מקור Go, או יישום של ישות ספציפית של שפה מיוצאת:

godoc fmt # תיעוד עבור החבילה fmt
godoc fmt Printf # תיעוד עבור fmt.Printf
godoc cmd/go # כוח תיעוד עבור הפקודה go
ממשק חבילת godoc -src fmt # fmt בצורת מקור Go
godoc -src fmt Printf # יישום של fmt.Printf

במצב שורת פקודה, הדגל -q מאפשר שאילתות חיפוש נגד godoc הפועל כ-a
שרת אינטרנט. אם לא צוינה כתובת שרת מפורשת עם דגל -שרת, תחילה godoc
מנסה את localhost:6060 ולאחר מכן http://golang.org.

godoc -q Reader
godoc -q math.Sin
godoc -server=:6060 -q sin

עם הדגל -http, הוא פועל כשרת אינטרנט ומציג את התיעוד כדף אינטרנט.

godoc -http=:6060

כברירת מחדל, godoc מסתכל על החבילות שהוא מוצא דרך $GOROOT ו-$GOPATH (אם מוגדר).
ניתן לציין ספריות נוספות באמצעות דגל ה-path המקבל רשימה של נקודתיים-
שבילים מופרדים; נתיבים לא שורשיים הם יחסית לספריית העבודה הנוכחית. כל שביל
נחשב כשורש נוסף לחבילות לפי סדר הופעתם. האחרון
רכיב נתיב (אבסולוטי) הוא הקידומת לנתיב החבילה. למשל, בהינתן הדגל
ערך:

path=".:/home/bar:/public"

עבור godoc שהתחיל ב- /home/user/godoc, נתיבים מוחלטים ממופים לנתיבי חבילה כ
התעופה

/home/user/godoc/x -> godoc/x
/home/bar/x -> bar/x
/public/x -> public/x

כאשר godoc פועל כשרת אינטרנט ומוגדר -index, אינדקס חיפוש נשמר. המדד
נוצר בעת ההפעלה.

האינדקס מכיל גם מידע מזהה וגם מידע חיפוש טקסט מלא (ניתן לחיפוש באמצעות
ביטויים רגולריים). ניתן להגדיר את המספר המרבי של תוצאות חיפוש בטקסט מלא המוצגות באמצעות
הדגל -maxresults; אם מוגדר ל-0, לא יוצגו תוצאות טקסט מלא, ורק מזהה
אינדקס אך לא נוצר אינדקס חיפוש טקסט מלא.

ניתן לשלוט במצב ההצגה של דפי אינטרנט המוגשים על ידי godoc באמצעות כתובת האתר "m".
פָּרָמֶטֶר; הוא מקבל רשימה מופרדת בפסיקים של שמות דגלים כערך:

את כל הצג תיעוד עבור כל ההצהרות, לא רק עבור אלו המיוצאות

שיטות
הצג את כל השיטות המוטמעות, לא רק אלה של שדות אנונימיים שלא מיוצאים

src הצג את קוד המקור המקורי ולא את התיעוד שחולץ

טֶקסט להציג את הדף בצורה טקסטואלית (שורת פקודה) במקום HTML

דירה הצג רישומי ספריות שטוחים (לא מחורצים) באמצעות נתיבים מלאים

לדוגמה, http://golang.org/pkg/math/big/?m=all,טקסט מציג את התיעוד עבור כולם
(לא רק הצהרות המיוצאות) של חבילה גדולה, בצורה טקסטואלית (כפי שזה ייראה
בעת שימוש ב-godoc משורת הפקודה: "godoc -src math/big .*").

כברירת מחדל, godoc משרת קבצים ממערכת הקבצים של מערכת ההפעלה הבסיסית. במקום זאת, .zip
ניתן לספק את הקובץ באמצעות דגל -zip, המכיל את מערכת הקבצים לשרת. הקובץ
נתיבים המאוחסנים בקובץ ה-zip חייבים להשתמש בקו נטוי ('/') כמפריד נתיבים; והם חייבים להיות
ללא שורש. יש להגדיר את $GOROOT (או -goroot) לנתיב ספריית ה-zip המכיל את ה-
עבור לספריית שורש. לדוגמה, עבור קובץ .zip שנוצר על ידי הפקודה:

zip go.zip $HOME/go

אפשר להפעיל את godoc באופן הבא:

godoc -http=:6060 -zip=go.zip -goroot=$HOME/go

ראה "Godoc: תיעוד קוד Go" כיצד לכתוב הערות טובות עבור godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

אפשרויות

-v מצב מילולי

-q ארגומנטים נחשבים לשאילתות חיפוש: שאילתה משפטית היא מזהה יחיד (כגון
כ-ToLower) או מזהה מוסמך (כגון Math.Sin).

-src הדפס (מיוצא) מקור במצב שורת פקודה

-טאב רוחב=4
רוחב טאבים ביחידות של רווחים

-חותמות זמן=אמת
הצג חותמות זמן עם רשימות ספריות

-אינדקס אפשר מזהה ואינדקס חיפוש טקסט מלא (לא מוצגת תיבת חיפוש אם -index הוא
לא מוכן)

-index_files=""
דפוס גלוב המציין קבצי אינדקס; אם לא ריק, האינדקס נקרא מאלה
קבצים בסדר ממוין

-index_throttle=0.75
ערך מצערת מדד; ערך של 0 פירושו שלא מוקצה זמן לאינדקס (ה
אינדקס לעולם לא יסתיים), ערך של 1.0 אומר שיצירת האינדקס פועלת בשעה
מצערת מלאה (גורוטינים אחרים עשויים שלא לקבל זמן בזמן שהאינדקס נבנה)

-write_index=false
לכתוב אינדקס לקובץ; יש לציין את שם הקובץ עם -index_files

-maxresults=10000
המספר המרבי של תוצאות חיפוש טקסט מלא המוצגות (לא נבנה אינדקס טקסט מלא אם
מקסימום תוצאות <= 0)

-path=""
ספריות חבילות נוספות (מופרדות בנקודתיים)

-html הדפס HTML במצב שורת פקודה

-goroot=$GOROOT
עבור לספריית שורש

-http=addr
כתובת שירות HTTP (למשל, '127.0.0.1:6060' או רק ':6060')

-שרת=addr
כתובת שרת אינטרנט עבור חיפושים בשורת הפקודה

-templates=""
ספרייה המכילה קבצי תבניות חלופיות; אם מוגדר, הספרייה עשויה לספק
קבצי תבניות חלופיות עבור הקבצים ב-$GOROOT/lib/godoc

-url=נתיב
הדפס לפלט סטנדרטי את הנתונים שיוגשו על ידי בקשת HTTP לנתיב

-zip=""
קובץ zip המספק את מערכת הקבצים לשרת; מושבת אם ריק

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