דוגמה מעשית
בדוגמא הזו נכתוב קטע קוד אשר קורא מקובץ:
הצהרה על משתנה מורכבת מתגיות פנימיות:
- ID– מציין את הזיהוי של המשתנה בקטע
- Default– מציין את הערך שיהיה כתוב שם במידה והמשתמש לא ישנה זאת
- ToolTip – מציג מידע למשתמש על המשתנה
אחרי שכתבנו את הקוד (אגב רצוי לבדוק אותו לפני), צריך להורות ל-Visual Studio שיכיר בו, לשם כך עלינו לשמור את הקובץ כ-ReadFile.Snippet. ניתן לשמור את הקובץ בתיקיה כלשהי אבל בכל מקרה הקובץ ש-Visual Studio ישתמש בו יהיה בנתיב C:\Users\User\Documents\Visual Studio 2010\Code Snippets\Visual C#\My Code Snippets, לכן אפשר להקדים ולשמור אותו שם מראש. אחרי ששמרנו את הקובץ, נפתח את ה-Code Snippets Manager וננווט ל-Tools -> Code Snippets Manager.
בחלון זה נבחר את האופציה Import.
ואז ננתב אל המיקום של הקובץ, ונבחר לאיזו קטגוריה אנחנו רוצים לסווג את הקטע קוד.
נלחץ על Finish. אחרי שסיימנו להוסיף את קטע הקוד יהיה ניתן לראות אותו במסך הראשי.
כעת בזמן הקידוד נוכל לכתוב ReadFile – TAB TAB והקוד יתווסף.
הערה: מומלץ לעבור כל קטעי הקוד הקיימים ממיקרוסופט, חבל שתכתבו משהו פעמיים ואתם תמיד יכולים ללמוד מהם. בהצלחה!
כמה תוספות חשובות
א) זהו כלי עבודה חשוב ומצויין. אין יום שאני לא משתמש בסניפטים. ואין כמעט חודש שאני לא מוסיף או עורך סניפט כזה או אחר.
ב) כלי הסניפטים יכול לעבוד גם עבור שפות שונות. באופן מוזר יש לו תמיכה טובה יותר בVB, אבל אינטגרציה פחות טובה. לך תבין…
ג) יש כלי נפלא (בחסות מיקרוסופט) שנקרא SNIPPET EDITOR, שיודע להציג בצורה נוחה יותר את הסניפט.
יותר ממומלץ!
מומלץ מאוד.
רק חבל שלא מצויין
שכל הכתבה הזאת נוגעת רק לVisual Studio.
Code Snippets הוא מושג כללי בעולם התכנות ורלוונטי לכל הIDEs באשר הן.
המבנה שמדובר עליו כאן, של קובץ XML, הוא לא בהכרח הנכון עבור כל תוכנת עריכה.
והקונספט של Intellisense, שאומנם המילה הזאת באמת של מייקרוסופט, קיים גם בעורכים נוספים.