תיעוד תוכן צפוי של ארגומנט אובייקט

[צדיק תמים]

אני כותב תיעוד לפונקציה שמעבירים אליה ארגומנט אחד שהוא אובייקט.
ניסיתי (לפי התיעוד) לכתוב תיעוד שמסביר מה אמור להיות בכל מפתח באובייקט:

* @param {object} objectInfo מערך המידע על הסרטון הספציפי
* @param {string} objectInfo.status סטטוס
* @param {string} objectInfo.id מזהה סרטון
* @param {string} objectInfo.title שם סרטון
* @param {string} objectInfo.publishedAt תאריך סרטון (בפורמט ידידותי)
* @param {string} objectInfo.ChannelName שם ערוץ של הסרטון
* @param {number} index מספר סרטון מתוך המערך שבטיפול
*/
function jsonTest(objectInfo) {
\\...

אבל בריחוף מופיע רק סוג המפתח (סטרינג), ולא התיאור שלו:

אשמח לדעת איך כותבים בצורה שיופיע גם התיאור.

[davidnead]

@צדיק-תמים הצורה שכתבת אינה נכונה, כי הכפלת את הפרמטרים, והכל זה פרמטר אחד של אובייקט.
לגוף השאלה איך מפרטים את התוכן של האובייקט הצפוי - גם אני נתקלתי בה ולא הצלחתי למצוא לה פתרון, אשמח לשמוע אם למישהו יש.
למיטב הבנתי זה אפשרי רק בtypeScript.

[צדיק תמים]

@davidnead אמר בתיעוד תוכן צפוי של ארגומנט אובייקט:

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

הסתכלת בקישור שהבאתי בפוסט הראשון לתיעוד? עשיתי את זה על פי זה.

[davidnead]

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