מהן פונקציות לדוגמה ב-Go?

טייק אווי מפתח

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

אחד היתרונות של Go הוא השפע של תכונות בדיקות ותיעוד מובנות. בין אלה יש כלי שימושי ביותר שנקרא "פונקציות לדוגמה" שיכול לעזור לך לבדוק את הקוד שלך ולהסביר אותו לאחרים.

כמפתחי Go, עליך להבין בדיוק מהן פונקציות לדוגמה וכיצד תוכל להשתמש בהן כדי לבנות תוכנה הניתנת לתחזוקה.

מהן פונקציות לדוגמה?

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

תאר לעצמך שיש לך את הדברים הבאים לְהַכפִּיל פונקציה בפרויקט שלך:

funcMultiply(a, b int)int {
return a * b
}

פונקציה לדוגמה עבור לְהַכפִּיל ייראה כך:

funcExampleMultiply() {
 fmt.Println(Multiply(4, 5))
// Output: 2
}

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

מבט מקרוב על פונקציות לדוגמה

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

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

ניתן להגדיר דוגמה לחבילה, פונקציה, סוג ומתודה על סוג.

הגדרת דוגמאות לגופים שונים דורשת גישות שונות.

1. כדי להגדיר דוגמה לחבילה, פשוט התקשר לפונקציה שלך דוגמא(), ללא שום סיומת. לדוגמה, הנה דוגמה ברמת החבילה:

   funcExample() {
    fmt.Println("Hello, world!")
   // Output:
   // Hello, world!
   }

2. כדי להגדיר דוגמה לפונקציה, אתה פשוט מוסיף את שם הפונקציה כסיומת כפי שלמדת קודם לכן.

   funcExampleMultiply() {
    fmt.Println(Multiply(4,5))
   // Output: 2
   }
   

3. כדי להגדיר דוגמה לסוג, הוסף את השם כסיומת ל דוגמא. הנה דוגמה:

   type MyStruct struct {
   // ...
   }
   funcExampleMyStruct() {
   // ...
   }
   

4. ולבסוף, עבור שיטה על סוג מסוים, אתה מוסיף את שם הסוג, קו תחתון, ולאחר מכן את שם השיטה. הנה הדגמה:

   func(m *MyStruct)MyMethod() {
   // ...
   }
   funcExampleMyStruct_MyMethod() {
   // ...
   }
   

ניתן להגדיר דוגמאות מרובות עבור ישות על ידי הוספת קו תחתון נוסף וסיומת המתחילה באות קטנה. לדוגמה, דוגמהMultiply_second, ExampleMyStruct_MyMethod_second.

תוכל גם לקבל דוגמה גדולה יותר כדי להסביר לוגיקה מורכבת באמצעות א דוגמה לקובץ שלם.

דוגמה לקובץ שלם הוא קובץ שמסתיים ב _test.go ומכיל בדיוק פונקציה לדוגמה אחת, ללא פונקציות בדיקה או ביצועים, ולפחות הצהרה אחת נוספת ברמת החבילה. בעת הצגת דוגמאות כאלה, godoc יציג את כל הקובץ. - הבלוג go dev

מנוע ה-Go מזהה ומטפל בפונקציות לדוגמה שלך בהתאם לאופן שבו אתה מגדיר אותן.

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

תיעוד הקוד שלך עם פונקציות לדוגמה

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

בדיוק כמו Javadoc של Java, Go's כלי תיעוד מובנה, godoc, עוזר לתעד קוד בקלות. אבל תרצה לתעד כמה ספריות ופונקציות יחד כדי לתת הבנה מלאה יותר של אופן הפעולה שלהם. דוגמאות מבטלות את הכישלון הזה מכיוון שהן יכולות להדגים את האינטראקציות בין יחידות שונות של חבילה.

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

אתה יכול לנסות חבילה או שיטה ישירות מהתיעוד עוד לפני השימוש בה בקוד שלך.

תמונה זו מציגה דוגמה עבור json. תָקֵף לתפקד תחת קידוד/json:

שימוש בפונקציות לדוגמה לבדיקת יחידה

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

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

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

זה עוזר רבות במניעת תיעוד מעופש, מכיוון שהתיעוד שלך תמיד יהיה מעודכן עם הקוד.

פונקציות לדוגמה מייצרות קוד ותיעוד מהימנים

תיעוד הוא חלק חיוני בפיתוח תוכנה, אך מעטות השפות נותנות לך פלטפורמה כה חזקה לתיעוד ולבדוק את הקוד שלך.

Go מגיע עם כל מה שאתה צריך כדי ליצור תיעוד איכותי עבור התוכנה שלך, ופונקציות לדוגמה הן חלק חיוני מזה. השתמש בדוגמאות כדי לעזור למשתמשים ולשתפי פעולה לאמץ ולהבין את הקוד שלך מהר יותר.