Создать собственный тип в документации - PullRequest
Новая
       4

Создать собственный тип в документации

0 голосов
/ 06 ноября 2018

Я хочу иметь хорошую документацию, и поэтому я хочу написать: 

@param {(device)} device

и когда я нажимаю на параметре устройства, я хочу видеть что-то вроде: 

configInSync:null
lastUpgradeStatus:"none"
lastUpgradeStatusReported:true
modelID:"F4FE7EBE"
packages:Object {}
registrationInSync:false
softwareVersion:3
UUID:"85196BFA6E90"

Итак, я хочу определить свой собственный тип, это возможно? Конечно, я пытался с

@ ЬурейеЕ

Но как создать такой тип "defice"? Меня судили: 

@typedef {configInSync:null
lastUpgradeStatus:"none"
lastUpgradeStatusReported:true
modelID:"F4FE7EBE"
packages:Object {}
registrationInSync:false
softwareVersion:3
UUID:"85196BFA6E90"} device

Решение: необходимо определить каждое свойство в типе, например: 

/**
 * @typedef {object} MessageProperties
 * @property {string} replyTo
 * @property {string} type
 * @property {string} messageId
 * @property {string} contentType
 * @property {string} correlationId
 * @property {number} expiration
 * @property {object} headers
 */

1 Ответ

0 голосов
/ 06 ноября 2018

Вы можете использовать typedef

Тег @typedef полезен для документирования пользовательских типов, особенно если вы хотите обращаться к ним повторно. Эти типы могут затем использоваться в других тегах, ожидающих тип, таких как @type или @ param. 

/**
 * The complete Triforce, or one or more components of the Triforce.
 * @typedef {Object} WishGranter~Triforce
 * @property {boolean} hasCourage - Indicates whether the Courage component is present.
 * @property {boolean} hasPower - Indicates whether the Power component is present.
 * @property {boolean} hasWisdom - Indicates whether the Wisdom component is present.
 */
...