נוֹף תיעוד CPAN בוצע
הורד עכשיו

נוֹף דירוג וסיכום

נוֹף תגים

פרל מודול תיעוד CPAN annotated תיעוד CPAN. תיעוד מבואר

נוֹף תיאור

המבואר תיעוד CPAN AnnoCPAN הוא ממשק אינטרנט Perl עבור תיעוד של כל המודולים על CPAN, שבו משתמשים יכולים להוסיף הערות בשולי פסקאות ספציפיות ברחבי POD. זהו תהליך בהתהוות. חלק מהרעיונות שניתנו כאן עשוי לשנות גם מעל ההתחלה של time.BackgroundLet ידי רישום חלק מהמשאבים העומדים לרשות הקהילה Perl. * CPAN הוא ארכיון נפלא ומערכת הפצה עבור מודולים Perl. * Search.cpan.org היא מאוד ממשק האינטרנט נחמד לחיפוש וגלישה מודולים CPAN ותיעוד שלהם. * rt.cpan.org היא מערכת מעקב באגים עבור מודולים CPAN, אבל זה לא נעשה שימוש על ידי כל המחברים מודול. * cpanratings.perl.org מאפשר למשתמשים לתת לציבור משוב וחוות דעת על מודולים. * אתרים כגון perlmonks.org ואת קבוצות דיון לאפשר לאנשים ללמוד ולדון בנושאים שונים עם מודולים Perl ו- Perl. * יש מודולים אתרי אינטרנט מסוימים, רשימות דיוור, או איזושהי בפורום דיון שבו אנשים יכולים לדון סוגיות לגבי המודול המבוקש. * CPAN :: פורום (אשר לא היה קיים כאשר התחלתי לעבוד על AnnoCPAN) הוא פורום דיון שבו האשכולות ממוינים לפי CPAN module.Where משתלבת AnnoCPAN ב? כשהתחלתי לעבוד על הפרויקט הזה יש wer דואר מודולים רבים על CPAN כי אין רשימות דיוור או במקומות אחרים בדיון. דיונים פזורים יכולים לקרות במקומות שונים, או חלק מהמשתמשים יכולים לפרסם הערות כלליות על cpanratings.perl.org. עם זאת, לא היה מקום מרכזי שבו משתמשים יכולים לעזור זה לזה באמצעות הערות על תכונות ספציפיות, שימושים, מכשלות, וכו 'עבור כל המודולים Perl. מגבלה של אתרים כמו CPANRatings (ו ל לאתרים אחרים במידה מסוימת כי ביקורות מארחות) היא כי ההערות מופיעות מחוץ להקשר של התיעוד של מודול, ולכן הם בכלל בהכרח אלא אם המחבר של התגובה מחליט לכתוב סקירה ארוכה להקים הֶקשֵׁר. AnnoCPAN מתכוונת למלא את הפער הזה על ידי מתן אפשרות למשתמשים להוסיף הערות הציבור על השוליים של תיעוד של כל מודול על הרעיון CPAN.The אינו חדש, כמובן; כבר יש MySQL ו- PHP משהו דומה. הבדל אחד הוא מציין כי AnnoCPAN שייכים פסקאות ספציפיות במקום פרקים, והם מוצגים על השוליים (או בין פסקאות, בהתאם לגיליון סגנונות) במקום בתחתית של page.How האם זה עובד? האתר AnnoCPAN יש תיעוד לכל המודולים CPAN, ומאגר "פתקים" שניתן להוסיף דרך ממשק האינטרנט. כאשר משתמש מציג תיעוד של מודול, תרמיל מוצג כ- HTML יחד עם הערות. זה מאפשר למשתמשים לכתוב הערות מאוד קצרות כי פערי מילוי בתיעוד; למשל, זה יכול להיות מספיק כדי לומר. "אזהרה:! מחזירה שיטה זו דברים שונים סקלר ובהקשר הרשימה ואת POD אינו מזכיר את זה" התוכנית היא להפוך את מסד הנתונים פתק זמין להורדה תחת רישיון פתוח כך שאתרי CPAN אחרים יכולים לבחור להציג את ההערות. זה יכול להיות גם אפשר ליצור תוכנית לתקן את תרמילי המקומיות מכונה של המשתמש כך הערות להופיע perldoc! (מסומנים בצורה ברורה כפי שמציין, כמובן) .the בעיה עם פתק versionsA מזוהה במספר הפצה, מודול, וסעיף. אבל מה קורה כאשר גרסה חדשה של מודול יוצא? הביאורים גם יצטרכו לקחת את מספר הגרסה של ההפצה בחשבון. אבל, האם זה קיימא להראות הערות ישנות עם POD של הגרסה החדשה? ואיפה? מספרים בפסקה יכול change.In ברוב המקרים, בתיעוד של הגרסה החדשה של מודול דומה מאוד לזו האחרונה. אם מדובר תוקן באג, לא היה יכול להיות שום שינויים בכלל; פונקציות שאחרות בדרך כלל מתווספות אך לא הוסרו. במקרים כגון זה, זה יהיה רעיון טוב להעביר את השטרות הישנים לגרסה החדשה. הפיסקה שאליה הפתק צורף במקור ניתן להשוות את הפסקאות בגרסה החדשה, ואם אחד הוא מספיק דומה (רצוי זהים), ההערה היא transferred.If המערכת לא יכולה להבין איפה לשים את הפתק הישן , המחבר או של מתווך יכול להזיז אותה למקום בגרסה החדשה שההערה עדיין חלה. יש לקוות חלק מהכתבים הטובים יהפוך מיושן פעם מחבר מודול מחליט לעדכן את התיעוד כדי לטפל בבעיות שהוזכרו note.Users מסוגלות לערוך, להעביר ולמחוק הערות משלהם. מנהלים הם משתמשים יוכלו להעביר או למחוק כל הערה. דרישות: · פרל

נוֹף תוכנה קשורה