תיעוד פרויקט ?

[starter500]

תיעוד פרויקט ?

שלום לכולם
כחלק מפיתוח אפליקציית ווב שאני עובד עליה - אני מחפש כלי ליצירת דוקומנטציה לפרויקט בצורה נוחה תוך כדי תנועה .
יש המלצות ?

 

[ברבוריאן]

הכי טוב זה לתעד בקוד ולנהל ב GIT או דומיו

לגבי מה שנקרא "ניתוח מערכת" זה הפך לכ"כ מופשט שמספיק WORD ויצירתיות שלך

 

[koler]

רוכב על הגל...

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

תודה.

 

[bnayal]

GIT ו-SVN נועדו לניהול גרסאות.

ניהול גרסאות נותן הרבה דברים:
1. מעקב אחרי תיקון באגים והוספת פיצ'רים.
2. עבודה בצורה נוחה עם צוות מתכנתים.
3. במקרה ויש צורך תמיד אפשר להחזיר את הקוד לגרסא ישנה יותר.

עד לאחרונה עבדתי רק עם SVN וכרגע התחלתי לעבוד עם GIT שעדיין לא ברור לי ב100% ההבדלים וממה הם נובעים. מה שבטוח, בלי ניהול גרסאות אני לא עובד יותר.

 

[gilmad]

ההבדלים המרכזיים:

בGIT כל צ'קאאוט יוצר אינסטנס מקומי של הרפוזיטורי.

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

אם משום מה השרת המרכזי שלך נפל והלך קפוט - מכיוון שכל צ'קאווט הוא שכפול של הרפוזיטורי אז ניתן לשחזר אותו מאותו אינסטנס.

אלו היו 60 שניות על למה GIT שווה יותר מSVN

 

[bnayal]

 

[על מה אני מדבר]

איזה יתרונות יש ל-SVN או GIT בעבודה של

מתכנת יחיד?

 

[gilmad]

גיבוי תמידי...

הכנסת בטעות באג לקוד שלך? שורה אחת ואתה חוזר לאיזה נקודה (ששמרת מבעוד מועד) שאתה רוצה.

אם אתה משתמש בשרת שהוא לא מקומי כמו bitbucket או github אז במידה וההארדיסק שלך נופל - יש לך גיבוי! עם כל ההיסטוריה...

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

ועוד יתרון צדדי - לפעמים אתה עוזב פרוייקט ולא נוגע בו למשך כמה שבועות וכשאתה חוזר מספיק לעבור על ההערות האחרונות שהכנסת לGIT / SVN כדי לחזור לנקודה שבא עזבת.

 

[amitayh]

אם אתה מתעד את כל הפונקציות/קלאסים עם

PHPDoc אפשר להשתמש ב - phpDocumentor כדי ליצר תיעוד של כל ה - codebase