תיאור
Doxygen - כלי התיעוד האולטימטיבי למפתחים
כמפתח, אתה יודע כמה חשוב שיהיה תיעוד ברור ותמציתי עבור הקוד שלך. ללא תיעוד מתאים, זה יכול להיות קשה להבין את המבנה של בסיס הקוד שלך, מה שיוביל לבלבול ושגיאות. זה המקום שבו Doxygen נכנס לתמונה - כלי רב עוצמה שיכול ליצור דפדפני תיעוד מקוונים ומדריכי עזר לא מקוונים מקובצי המקור שלך.
Doxygen היא תוכנה חינמית וקוד פתוח שקיימת מאז 1997. היא הפכה לאחד מכלי התיעוד הפופולריים ביותר בקרב מפתחים בשל קלות השימוש, הגמישות והתכונות החזקות שלה. עם Doxygen, אתה יכול בקלות ליצור תיעוד בעל מראה מקצועי עבור הפרויקטים שלך מבלי לבזבז שעות בכתיבה בעצמך.
אחת מתכונות המפתח של Doxygen היא היכולת שלו לחלץ תיעוד ישירות מקבצי המקור שלך. משמעות הדבר היא שאינך צריך לכתוב קבצי תיעוד נפרדים או לתחזק אותם בנפרד מבסיס הקוד שלך. במקום זאת, אתה פשוט מוסיף הערות לקבצי המקור שלך באמצעות תגים מיוחדים ש-Doxygen מזהה.
תגים אלו מאפשרים לך לתעד היבטים שונים של הקוד שלך כגון פונקציות, מחלקות, משתנים ועוד. אתה יכול גם לכלול מידע על פרמטרים, ערכי החזרה, חריגים שנזרקו על ידי פונקציות או מתודות וכו', מה שיקל על מפתחים אחרים (או אפילו על עצמך) להבין איך הקוד עובד.
לאחר שהוספתם את ההערות הללו לאורך קבצי המקור שלכם (מה שאולי נראה מייגע בהתחלה אבל משתלם בגדול), הפעלת Doxygen תייצר ממשק דפדפן מבוסס HTML עם כל המידע הרלוונטי לגבי כל פונקציה/מחלקה/משתנה/וכו'. , כולל כל דיאגרמות משויכות כמו עצי ירושה או דיאגרמות שיתוף פעולה.
אבל מה אם חלקים מסוימים של הקוד אינם מתועדים? אין בעיה! עם אפשרויות התצורה של Doxygen (שהן נרחבות), אתה יכול להגיד לו אילו חלקים לא מתועדים צריכים להיכלל בפלט שנוצר בכל מקרה - כך גם אם יש פערים בידע על אזורים מסוימים, הם לא יחסרו לחלוטין מהעין בעת הגלישה. מסמכים שנוצרו מאוחר יותר בהמשך הדרך!
תכונה נהדרת נוספת של Doxygen היא התמיכה שלו בהפקת פלט בפורמטים שונים כגון RTF (MS-Word), PostScript/PDFs/קובצי PDF מקושרים/דפי HTML/Unix דחוסים וכו'. זה אומר שלא משנה באיזה פורמט מישהו מעדיף את המסמכים שלו סביר להניח שהם ימצאו כאן משהו מתאים!
גרפי התלות בהכללה שהוזכרו קודם לכן הם תכונה נהדרת נוספת: אלה מראים כיצד אלמנטים שונים בתוך פרויקט קשורים זה לזה ויזואלית כך שמשתמשים מקבלים מושג במהירות היכן הכל מתאים למקומו מבלי לקרוא כל שורה בעצמם מראש; זה חוסך זמן במיוחד כאשר עובדים עם פרויקטים גדולים המכילים רכיבים רבים תלויים זה בזה.
דיאגרמות ירושה מספקות יתרונות דומים על ידי הצגת יחסים בין מחלקות/ממשקים/וכו', בעוד שדיאגרמות שיתוף פעולה מציגות אינטראקציות בין אובייקטים שונים בתוך אותן מחלקות/ממשקים/וכו'. /files/folders/etc..
בסך הכל, אנו ממליצים בחום לנסות את DoxyGen אם מחפשים כלי קל לשימוש אך רב עוצמה המסוגל ליצור מסמכים באיכות גבוהה במהירות וביעילות!
מפרט מלא
| מוֹצִיא לָאוֹר | Dimitri van Heesch |
| אתר מוציא לאור | http://www.stack.nl/wiki/MCGV_Stack |
| תאריך הוצאה | 2013-08-26 |
| תאריך הוסף | 2013-08-26 |
| קטגוריה | כלי מפתח |
| תת קטגוריה | כלי קוד המקור |
| גִרְסָה | 1.8.5 |
| דרישות Os | Windows 2000, Windows Vista, Windows, Windows 7, Windows XP |
| דרישות | None |
| מחיר | Free |
| הורדות בשבוע | 0 |
| סה"כ הורדות | 679 |
Comments: