Как правильно документировать свойства и метод объекта с помощью JSDO C? - PullRequest
Новая
       27

Как правильно документировать свойства и метод объекта с помощью JSDO C?

0 голосов
/ 09 февраля 2020

Я не могу найти какую-либо документацию, относящуюся к topi c, хотя она кажется очень простой c. Я хочу документировать простой объект со свойствами и методами. Я хочу, чтобы они были доступны в документации HTML, созданной JSDO C. Я использую Javascript в узле.

Вот что у меня есть: 

/**@type {object} */
const obj = {
    /**@type {number} */
    prop: 12,
    /**@type {number[]}*/
    oneMoreProp: [1, 2, 3, 4, 5],
    /**
    * Mult: Multiplies 2 numbers
    * @param {number} a - First number
    * @param {number} b - Second number
    */
    mult(a, b) {return a * b}
}

В способе, который я создал, может быть несколько ошибок: c. Я также был бы признателен, если бы кто-нибудь знал хороший учебник для глубокого понимания JSDO C, официальная документация не помогает овладеть asp базовой практикой c.

...