Lo que estoy tratando de lograr es documentar propiedades que tienen el tipo "Objeto", por ejemplo

 props: { foo: { type: Object, required: true } }

Ahora este objeto foo puede y tendrá múltiples entradas de las cuales algunas son obligatorias mientras que otras serán opcionales. p.ej

 <my-component :foo="{ mandatoryItem1: 'bar', mandatoryItem2: { mayBeEvenNested: true }, optionalItem1: 'baz', ... }" />

El problema es que al usar la propiedad, debe verificar el código fuente del componente para saber qué entradas deben estar presentes en la propiedad. Si bien el uso de mecanografiado también eliminaría este problema sería excelente, no podemos cambiar a TS en este momento, por lo que debemos usar jsDoc en su lugar. Y nos gustaría hacerlo de la manera adecuada.

Al documentar funciones y sus parámetros, puede describir un objeto de parámetro anidado como este (o algo así):

 /** * @param bar {Object} object containg... * @param bar.mandatoryItem1 {String} ... * @param bar.mandatoryItem2 {Object} ... * @param bar.mandatoryItem2.mayBeEvenNested {Boolean} ... */ function foo(bar) { }

¿Cómo puedo hacer lo mismo o algo así para una propiedad vue?

Idealmente, nos gustaría usar algo como vue-styleguidist en el futuro, así que genere automáticamente los documentos para nuestros componentes usando jsDoc, por lo que es importante usar la sintaxis "correcta".

PD: Nos gustaría hacer lo mismo para las propiedades con el tipo "Array", es decir, describir cómo se verían los objetos en la matriz.