יצירת תיעוד קוד אינליין באמצעות GitHub Copilot

הושלם

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

GitHub Copilot Chat יכול לעזור לך לתעד קוד במהירות, בדיוק ובעקביות.

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

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

יצירת תיעוד קוד מוטבע באמצעות תצוגת הצ'אט

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

כל אחד משלושת מצבי תצוגת הצ'אט (Ask, Agent ו-Plan) יכול לשמש ליצירת תיעוד קוד מובנה. עלות השימוש במצב סוכן גבוהה יותר מהמצבים האחרים, שעשויים להיות שיקול.

יצירת תיעוד קוד מוטבע באמצעות תצוגת הצ'אט במצב 'שאל'

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

1. פתח את תצוגת הצ'אט במצב 'שאל'.

2. הוסף הקשר לבקשת הצ'אט. לדוגמה, הוסף קובץ markdown המספק הנחיות לתיעוד.

3. הזן בקשה ליצירת תיעוד של קוד מוטבע. לדוגמה, באפשרותך להזין את הבקשה הבאה:

   Suggest inline code documentation for the ConsoleApp class.
   

4. עיין בתיעוד הקוד המוטבע המוצע בתצוגת הצ'אט.

   

5. כאשר תהיה מרוצה מהתיעוד המוצע, תוכל להחיל את התיעוד המוצע על קובץ הקוד המתאים.

   העבר את מצביע העכבר מעל התיעוד המוצע כדי לראות את כפתורי Apply in Editor, Insert at Destinorו-Copy . כפתור Apply in Editor משמש ליישום התיעוד המומלץ על קובץ הקוד.

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

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

   

   השתמש בחצים למעלה ולמטה בשורת התפריטים התחתונה כדי לנווט בין העדכונים המוצעים.

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

   באפשרותך גם לשנות הצעות באופן ידני לפי הצורך.

7. כדי לקבל או לדחות את כל ההצעות, בחר בכפתור שמור או ביטול בתפריט התחתון.

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

יצירת תיעוד קוד פנימי באמצעות תצוגת הצ'אט במצב Plan

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

1. פתח את תצוגת הצ'אט במצב תוכנית.

2. הזן הנחיה שמתארת את משימות התיעוד הפנימי שלך.

   לדוגמה, באפשרותך להזין את הבקשה הבאה:

   Create a plan for adding inline code documentation to the codebase. Document classes, properties, and methods. Identify all files that need documentation updates.
   

3. בדוק את תוכנית היישום.

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

4. לאחר סיום התוכנית, בחר ב-Start Implementation כדי להעביר את התוכנית למצב סוכן, או בחר Open in Editor כדי לשמור את התוכנית כקובץ Markdown לשימוש עתידי.

   כשאתה בוחר ב-Start Implementation, GitHub Copilot עובר למצב סוכן ומתחיל להוסיף תיעוד קוד מוקלט בהתבסס על התוכנית המאושרת.

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

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

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

צור תיעוד של קוד מוטבע באמצעות תצוגת הצ'אט במצב סוכן

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

1. פתח את תצוגת הצ'אט במצב סוכן.

2. הוסף הקשר לבקשת הצ'אט. לדוגמה, השתמש בכפתור Attach Context (אייקון מהדק נייר) כדי להוסיף תיקיות קוד מקור לצ'אט.

3. הזן בקשה שמגדירה את משימות התיעוד שלך.

   לדוגמה, באפשרותך להזין את הבקשה הבאה:

   Create inline code documentation for all C# class files in the specified context. Document the class, properties, and methods. Do not add documentation to JSON, markdown, or other file types. Do not document UnitTest project files in the Test folder. Ensure that the solution builds without errors after the documentation is added.
   

4. הסוכן מציג הודעות מצב בתצוגת צ'אט כאשר הוא משלים את המשימות המבוקשות.

   

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

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

   

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

6. נווט בין העדכונים כדי לקבל, לדחות או לשנות הצעות בודדות.

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

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

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

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

צ'אט מוטבע מציע תיעוד קוד מוטבע ישירות בעורך הקוד.

1. פתח את קובץ הקוד בעורך.

2. בחר את הקוד שברצונך לתועד.

3. התחל הפעלת צ'אט מוטבע.

   השתמש בקיצור המקלדת Ctrl+I או בחר את Open Inline Chat מתפריט הצ'אט .

4. הזן בקשה ליצירת תיעוד של קוד מוטבע.

   לדוגמה, באפשרותך לת מסמך שיטה ולבקשות פרטים ספציפיים:

   Document the selected method. List currentState options
   

5. עיין בתיעוד הקוד המוטבע המוצע בעורך.

6. השתמש בכפתור השמור , קבל את העדכון המוצע או בטל כדי לדחות את העדכון.

תקציר

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