השאלות האלה מקבלות בדרך כלל תשובה קצרה ופשוטה מאוד - לינק לדוקומנטציה של Action Script.
אחד מהדברים החשובים שצריך לדעת כמפתח זה להשתמש במשאבים שלך, ובמקרה שלנו Adobe כתבה לנו אחלה של משאב.
במאמר זה אני יוצא מנקודת הנחה שאתם מכירים את המושגים הבסיסיים בעולם התכנות וה-Action Script. במידה ולא, אני ממליץ לקרוא את המאמר:
articles/programming-flash-actionscript-terms-hebrew-dictionary-t407.html
אז מה זה דוקומנטציה?
דוקומנטציה (תיעוד) זה בעצם מסמך שמפרט את כל מה שאנחנו רוצים לדעת לגבי השפה בה אנחנו משתמשים, במקרה שלנו ActionScript.
אנחנו יכולים למצוא בה מידע לגבי איך לכתוב בAS (עם דוגמאות כמובן), איזה מחלקות (classes) יש בה ומה כל מחלקה מכילה (ממי היא יורשת, איזה פונקציות ומאפיינים יש לה וכו...).
אסביר בפירוט מה נותנת לנו הדוקומנטציה של ActionScript3, ברגע שמבינים את הקטע, אפשר להסתדר בקלות גם עם התיעוד של ActionScript2 (או של רוב השפות האחרות לצורך העניין).
איך מגיעים לזה?
הלינק הראשי של הדוקומנטציה של AS3:
http://www.adobe.com/livedocs/flash/9.0 ... LangRefV3/
הלינק הראשי של הדוקומנטציה של AS2:
http://help.adobe.com/en_US/AS2LCR/Flas ... Ref_1.html
בכללי מה שאני עושה כשאני רוצה מידע על מחלקה מסויימת, google זו הדרך הכי מהירה.
פשוט צריך לחפש את שם המחלקה + שם השפה (as2/as3) ותגיעו בתוצאה הראשונה למה שאתם מחפשים.
לדוגמא, אני רוצה מידע על המחלקה Loader באמצעותה ניתן לטעון תמונות וקבצי swf לתוך swf מסויים, אני נכנס לgoogle ורושם: "Loader as3".
כמו שאני ציפיתי... התוצאה הראשונה תיקח אותי לדוקומנטציה של המחלקה Loader בas3.
כשלוחצים על הלינק הזה מגיעים ל: http://www.adobe.com/livedocs/flash/9.0 ... oader.html
אז מה בעצם יש שם?
בואו נראה מה הדף הזה נותן לנו.
לאורך כל הדוגמאות נסתכל על המחלקה Loader, ואני ממליץ בחום שתקראו את החלק הבא של המאמר תוך כדי מעבר על החלקים הרלוונטיים בדוקומנטציה של המחלקה.
שוב... הנה הלינק:
http://www.adobe.com/livedocs/flash/9.0 ... oader.html
Package:
דבר ראשון רואים את הpackage של המחלקה.
זה מידע די שימושי, שכן בשביל לייבא את המחלקה Loader לתוך מחלקה שאנחנו בונים, צריך לייבא אותה דרך הpackage הזה.
דוגמא:
בדוקומנטציה רשום שהpackage של Loader הוא flash.display.
מכאן נראה שכדי לייבא את המחלקה Loader נכתוב:
Using actionscript3 Syntax Highlighting
Class:
שם המחלקה והscope שלה... שתדעו.
:Inheritance
עץ הירושה של האובייקט, במקרה של Loader:
Loader -> DisplayObjectContainer -> InteractiveObject -> DisplayObject -> EventDispatcher -> Object
כלומר, Loader יורש מDisplayObjectContainer יורש מInteractiveObject וכו...
*סתם הערת ביניים, בActionScript אין ירושה כפולה...אז לא צריך לצפות לבלאגן בחלק הזה

Language Version:
גרסת השפה. במקרה שלנו: as3.
Runtime Versions:
הגרסאות עליהן המחלקה יכולה לרוץ (מבחינת נגן flash או air).
במקרה של Loader זה Air1.0 ו FlashPlayer9.
זה אומר שניתן לייצא את קובץ הswf שלנו לגרסת FlashPlaye9 או חדשה יותר (כמובן שלא לישנה יותר).
יש מחלקות כמו המחלקות של מנוע הטקסט החדש של פלאש (FTE) שהRuntime version שלהן הוא FlashPlayer10, וזה אומר שניתן לייצא את קבצי הswf שלנו לגרסת FlashPlayer10 ומעלה, לדוגמא:
http://ressources.mediabox.fr/doc/html/ ... Block.html
תיאור של המחלקה (ישר מתחת לRuntime Versions):
כאן זה מתחיל להיות מעניין. מספרים לנו מה בכלל יעוד המחלקה, מה היתרונות והחסורונות שלה, איזה מגבלות (במידה ויש) יש לה, איך היא משפיעה על security ועוד הרבה מידע...
אם נסתכל על השורה הראשונה של התיאור של Loader, נראה שכתוב:
The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files. Use the load() method to initiate loading. The loaded display object is added as a child of the Loader object.
תראו איזה יופי, רק מלקרוא את שתי השורות האלה אני יכול להבין אם המחלקה הזאת היא בכלל מה שאני מחפש, ובמידה שכן כתוב מה אני יכול לעשות איתה.
See also:
רשימה של לינקים לדוקומנטציה של מחלקות והסברים שקשורים למחלקה עליה אנחנו קוראים.
אל תתעלמו מזה, יש שם מידע ממש מועיל! סתם לדוגמא במקרה של Loader, יש קישור להסבר על איך בכלל להשתמש במחלקה: הלינק בשם Loading display objects שלוקח ל
http://www.adobe.com/livedocs/flash/9.0 ... 00171.html
Public properties:
רשימה של כל המאפיינים של המחלקה. שימו לב למבנה (ניקח לדוגמא את המאפיין הראשון של (Loader:
יש לנו את שם המאפיין והסוג שלו (איזו מחלקה הוא): content:DisplayObject, כאשר content זה שם המאפיין וDisplayObject זה הסוג שלו.
מתחת לזה רשום תיאור של המאפיין.
שימו לב שאם רשום בתחילת התיאור [read only], למאפיין הזה יש רק getter ואין setter, כלומר – ניתן רק לקבל אותו ולא לשנות אותו.
מצד ימין רשום Defined By, שזה בעצם אומר באיזו מחלקה הוגדר המאפיין (במקרה שלנו – הוא הוגדר ב- Loader).
שתי הערות חשובות:
1. בלחיצה על שם המאפיין נקפוץ לחלק בדוקומנטציה שמסביר יותר בהרחבה על אותו המאפיין.
2.שימו לב שממש מתחת לכותרת Public properties רשום "Show Inherited Public Properties".
בלחיצה על זה תראו את כל התכונות שהמחלקה ירשה מהמחלקות ממנה היא יורשת.
במצב זה, בחלק של "Defined By" תראו באיזו מחלקה בדיוק המאפיין נכתב.
Pubilc Methods:
כאן יש רשימה של כל הפונקציות של המחלקה.
זה בנוי בצורה זהה למאפיינים (Public properties), רק שכאן אנחנו רואים מה החתימה של הפונקציה (איזה פרמטרים היא מקבלת), ומה היא מחזירה.
לכל פרמטר בחתימה של הפונקציה יש שם וסוג(data type). בלחיצה על הסוג תגיעו לדוקומנטציה של אותה המחלקה.
לדוגמא, הפונקציה load של האובייקט Loader מקבלת בפרמטר הראשון פרמטר מסוג URLRequest. מה זה בכלל URLRequest? תלחצו על הלינק ותראו

עוד משהו קטן בנושא – הפונקציה הראשונה שנראה בחלק הזה של הדוקומנטציה הוא הconstructor (הבנאי) של המחלקה. ככה אתם יכולים לדעת איזה וכמה (אם בכלל) פרמטרים צריך להעביר לאובייקט כשיוצרים אותו.
Events:
רשימה של כל הארועים שהוגדרו באובייקט.
אבל רגע, אם נסתכל ברשימה של האובייקט Loader נראה שהיא ריקה. האם זה אומר שהאוביקט Loader לא יורה ארועים(מה שניקרה מדספצ' ארועים)?
ממש לא! אם תלחצו על "Show inherited Events" תקבלו רשימה של כל הארועים אותם Loader ירשה ויכולה לירות.
Property details, Constructor details ו-Method details:
בחלקים האלה מפרטים על כל המאפיינים והפונקציות עליהן קראנו בקצרה בחלקים הקודמים.
ברגע שמצאתם מאפיין/פונקציה שרלוונטי אליכם - זה מאוד יעזור לקרוא את החלק הזה.
והחלק האחרון והמאוד חשוב – Examples:
זה חלק מאוד נחמד בו אפשר לראות איך מיישים שימוש במחלקה עליה אנחנו קוראים.
מפורט שם איך להשתמש בדוגמא ומה בדיוק ניתן להפיק ממנה.
אל תפחדו מהדוגמאות, ברגע שצליחים להבין מה קורה שם זה יכול לחסוך לכם הרבה הרבה זמן.
לסיכום:
זהו, עברו על כל מה שהדוקומנטציה נותנת לנו.
חשוב לציין ששימוש בדוקומנטציה הוא חלק בלתי נפרד מפיתוח.
ככל שנשבור את הראש יותר על להבין איך הדברים עובדים, ככה נשתפר כמתכנתים (כמובן שגם למעצבים בפלאש יש הרבה מה לשאוב מהמקור הזה).
עם זאת, עד כמה שהדוקומנטציה היא מקור גדול למידע, היא רק טיפה קטנה למה שיש לנו אי שם בעולם האינטרנט... ומה היא המסקנה מהמשפט הפלצני הזה?
אם אתם לא מבינים/מצליחים משהו - תשתמשו בחיפוש או Google it!




חדשות