מדריך הכרות עם Code Snippets

מאמר זה הוא הזוכה הרביעי באתגר הכתיבה שלנו בנושא פיתוח תוכנה.

מה זה בכלל Code Snippets?

 
IntelliSense Code Snippets הינם השלמה אוטומטית לקטעי קוד קבועים, או קצת יותר בפירוט, הם קבצי XML הבנויים לפי סכימה (XSD). כמו כן, Code Snippets נמצאים בשימושם של מפתחים לכתיבת קוד מהיר יותר ולכן ניתן לצמצם את הזמן שנדרש כדי לקודד. כאשר מפתחים קוד תמיד יש תבניות שחוזרות על עצמן עם שינויים קטנים, בכמה מן המקרים כדאי לשקול לכתוב את אותו קטע קוד בצורה אוטומטית כדי לחסוך זמן (ההוספה היא באמצעות IntelliSense). כדאי להשתמש ביכולת על מנת להפחית את הכמות הטכנית של הקידוד ולהפחית בעיות שעלולות להתרחש על ידי המפתחים (חסרה קריאה למתודה, שכחנו לסגור קובץ ועוד).
 
אז איך מתחילים?
 
בניית Code Snippets (קטע קוד בעברית) הינו דבר פשוט, כל שעליך לעשות הוא לעבוד לפי סכימת XML (רצוי לקרוא את הסמכה לפני תחילת העבודה). דבר ראשון יש ליצור קובץ XML חדש כאשר נשמור אותו נשתמש בסיומת Snippet. ואחרי שיש לנו את הקובץ צריך להוסיף אכיפה של סכימה ולכן נוסיף את השורה הבאה: 
 
כך אמור להראות תחילת כתיבת Code Snippet:
זהו הבסיס לקטע קוד, החלק העליון (Header) מייצג את המידע לגבי ה-Snippet, ואילו החלק התחתון (Snippet) מכיל את הקוד. נתחיל ב- Header, איזה מידע כבר קיים לגבי הקטע קוד שלנו?
  • Author – שם הכותב
  • Description – תיאור הפונקציונליות של הקטע קוד, התיאור יופיע ב ToolTip אשר מופיע לפני ההוספה של הקטע
  • HelpUrl – כתובת שמספקת יותר מידע לגבי הקטע קוד
  • Keywords – מיועד עבר ספקי תוכן, אשר רוצים להוסיף מילים עבור מנועי חיפוש
  • Shortcut – מילת הקיצור כדי להכניס את הקוד, לדוגמא PROP / CTOR
  • SnippetTypes – מציין עבור ה Visual Studio איך להוסיף את הקוד
  • SurroundsWith – עוטף את הקטע קוד הנבחר
  • Expansion – מרחיב את קטע קוד הנבחר
  • Title – מציין את הכותרת של הקטע קוד אשר יופיע ב-Code Snippets Manager
אחרי שעשינו את כל ההגדרות עבור קטע הקוד הגיע הזמן לבנות אותו, ולשם כך יש לנו את התג Snippet. תחת התג הזה מופיעים לנו 4 תגים נוספים, אין חובה להוסיף את כולם רק את זה של קטע הקוד:
  • References – מציין באיזהDDL  צריך להוסיף כדי להשתמש בקטע הקוד
  • Imports – לאיזה שם צריך לעשות Using
  • Declarations – הצהרה על משתנים בקטע קוד, לא משתנים שאנחנו משתמשים בהם אלא קטעים שבהם המשתמש צריך לשנות את הערך בהתאם לתוכנית, נרחיב בהמשך
  • Code – הקוד עצמו. יש לציין באיזה שפה כותבים לכתוב את הקוד בתוך תגית CDATA