סקור את התכונות "הסבר" ו"מסמך" של GitHub Copilot

  • 5 דקות

GitHub Copilot מקל על מפתחים לעבוד עם קוד מורכב או לא מוכר. ב- Visual Studio Code, למפתחים יש גישה ישירה לתכונות GitHub Copilot שמנתחות, מסבירות או מציגות קוד מסמך.

ניתוח והסבירה של קוד באמצעות GitHub Copilot

ניתן להשתמש בתכונות הבאות של GitHub Copilot כדי לנתח ולהסביר את הקוד:

  • מצב 'שאל': השתמש בתצוגת צ'אט במצב 'שאל' כדי לנתח את סביבת העבודה כולה ולשאל שאלות אודות קידוד נושאים, מושגים של טכנולוגיה ושיטות תיכנות כלליות.

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

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

  • צ'אט מהיר: שאל שאלה מהירה והיכנס שוב למה שאתה עושה.

צור תיעוד קוד מוטבע באמצעות GitHub Copilot

ניתן להשתמש בתכונות הבאות של GitHub Copilot ליצירת תיעוד קוד מוטבע:

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

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

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

  • צ'אט מוטבע - השתמש בהפעלת צ'אט מוטבע כדי לעבוד ישירות בעורך הקוד. הצ'אט המוטבע שימושי כאשר ברצונך לתועד קוד ספציפי (כיתות, שיטות או בלוקי קוד) מבלי לצאת מהעורך. באפשרותך לספק הוראות ספציפיות בשורת הפקודה או להשתמש בפקודה קו /doc נטוי ללא מידע ספציפי, אם תרצה. עדכונים מוצגים בעורך הקוד ובאפשרותך לקבל או לדחות אותם. באפשרותך גם לבחור באפשרות להפעיל מחדש את הבקשה עם או בלי עדכונים.

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

צור תיעוד פרוייקט באמצעות GitHub Copilot

ניתן להשתמש בתכונות הבאות של GitHub Copilot ליצירת תיעוד פרוייקט:

  • תצוגת צ'אט במצב 'שאל': השתמש במצב 'בקש' כדי לנתח את בסיס הקוד ולהשיג הבנה של פרוייקטי הקוד, הקבצים והכיתות. השתמש במצב 'בקש' כדי להציג תצוגה מקדימה של תיעוד פרוייקט מוצע. סקור הצעות ובקש עדכונים או פרטים אחרים לפי הצורך. הוסף את התיעוד המוצע לקובץ תיעוד פרוייקט (README.md).

  • תצוגת צ'אט במצב עריכה: יצירת קובץ תיעוד של פרוייקט (README.md).

  • תצוגת צ'אט במצב סוכן: צור אוסף של קבצי תיעוד של פרוייקט: צור/עדכן את README.md, צור/עדכן את UsageExamples.md וצור/עדכן את ChangeLog.md. כלול קישורים בין קבצי התיעוד, הכיתות והשיטות של הפניות מקושרות והבטיח עקביות בין מסמכים.

חשוב

בעת שימוש בתצוגת צ'אט במצב סוכן, GitHub Copilot עשוי לבצע בקשות Premium מרובות כדי להשלים משימה בודדת. בקשות Premium יכולות לשמש בקשות שהופעלו על-ידי המשתמש ופעולות המשך טיפול ש- Copilot מבצע בשמך. מספר הבקשות הכולל של הפרימיום שנמצא בשימוש תלוי במורכבות המשימה, במספר השלבים המעורבים ובמודל שנבחר.

תקציר

GitHub Copilot עוזר לך לנתח ולתעד את הקוד שלך במהירות ובמדויקת. תצוגת הצ'אט, הצ'אט המוטבע, הצ'אט המהיר ותכונות הפעולה החכמה מספקים רמות אינטראקציה שונות ישירות בתוך סביבת Visual Studio Code.