如何记录只有原始值的对象?
How to document an object with only primitive values?
我想使用 JSDoc 记录不能将对象作为值的对象。
允许的示例:
{
position: 'ground',
age: 0,
alive: false
}
示例不允许:
{
data: [/* ... */]
people: {/* ... */}
}
有没有办法做到以上几点?
例如可以在 @type
.
中完成
您可以使用带有@typedef 的联合来定义自定义类型
@typedef {(number|string|boolean|...)} YourType
然后在您的对象文档中引用此类型
我想使用 JSDoc 记录不能将对象作为值的对象。
允许的示例:
{
position: 'ground',
age: 0,
alive: false
}
示例不允许:
{
data: [/* ... */]
people: {/* ... */}
}
有没有办法做到以上几点?
例如可以在 @type
.
您可以使用带有@typedef 的联合来定义自定义类型
@typedef {(number|string|boolean|...)} YourType
然后在您的对象文档中引用此类型