Online JSDoc Generator

מטרת הכלי: הוא מייצר מסמכי JSDoc מתוך מקורות JavaScript ו-TypeScript. הוא קורא קבצי מקור, מחלץ הצהרות מתועדות ומייצר ייחוס API מובנה להתאמה למחברי ספריות, צוותי SDK ופרויקטים בקוד פתוח. הוא תומך בסוגי TS כשקיימים ומשפר דיוק תיאור הפרמטרים ומאפשר קישוריות בין מודולים וסמלים.
לוגיקה עיקרית ויכולות: הכלי מקבל מקורות, מחלץ בלוקים JSDoc, פותר סמלים ומייצא ל-HTML, Markdown או JSON. הוא תומך בפרויקטים מרובי קבצים, תיקיות וקלדני ריפוזיטורי. אפשרויות מתקדמות כוללות תבניות מותאמות אישית, קבוצות מודולים, נראות חברי פרטיים, יצירה אינקרמנטלית, הנחת TypeScript והוקים לעיבוד לאחר-ייצוא ל-CI.
קלט ופלט: קלט כולל source_paths (מחרוזת או מערך, נתיבים או URL של המאגר), שפה (JS/TS), פורמט פלט (html, markdown, json), תבנית (שם או תוכן), include_private (בוליאני). פלט כולל docs_html, docs_markdown, docs_json ואינדקס מודולים/מחלקות יחד עם אינדکس חיפוש.
אלגוריתמים וחישובים: משתמש ב-AST解析 לאיסוף סמלים והערות JSDoc, מקשר הערות להכרזות, מסמן גבולות מודול ויישם תבניות ליצירת מסמכים מובנים. אימות תחביר וטיפול בסינקטקס שאינו נתמך עם טקסטי חלופי להערות חסרות.
שגיאות ומקרי קצה: מטפל ב-JSDoc חסרים או בלתי-מלאים באמצעות לוגים והפקת מסמכים חלקיים; מסוגל לעבודה עם קוד גדול באמצעות עיבוד בזרימה; מספק ערכי ברירת מחדל לאפשרויות שאינן מוגדרות; מביא אזהרות על כשלי גישה למאגר או מגבלות קצב.
תעשייה/אזור ולוקליזציה: עוקב אחרי קונבנציות הערות הקוד באנגלית אמריקאית; תבניות תומכות כותרות מתורגמות; ללא נתוני מטבע או אזור; תואם לקונבנציות דוקומנטציה JS/TS.
הנחות והפצות: מניח שהקלט הוא קוד נגיש שניתן לניתוח; חריגה מעבודה עם דוקומנטים של ביצוע בזמן ריצה או נתוני זמן-ריצה או יצירת UI; איננו אחראים לאירוח או הצגה מעבר לפורמטים של פלט שנבחרו.