returns - jsdoc return

JSDoc typedef en un archivo separado

Question

¿Puedo definir todos los tipos personalizados en un archivo separado (por ejemplo, types.jsdoc ), para que puedan reutilizarse en toda la aplicación? ¿Cuál es la forma correcta de hacerlo?

/**
 * 2d coordinates.
 * @typedef {Object} Coordinates
 * @property {Number} x - Coordinate x.
 * @property {Number} y - Coordinate y.
 */

Answer 1

Acabo de probar con VSCode y funciona solo si el archivo separado se abre en el editor. Si no es así, typedefs externos se escriben como cualquier

Answer 2

Definirlos todos en un módulo (por ejemplo, typedefs.js ) funcionó para mí: el módulo contiene todos los typdefs jsdoc y luego solo exporta un objeto {} vacío. Lo importo donde quiero usar las definiciones de tipo (por ejemplo, const typedefs = require("./typedefs"); ). Es un pequeño paso extra pero no es difícil.

Answer 3

Generalmente hago algo similar en mis proyectos, la diferencia es que uso la extensión .js para nombrar el archivo. Webstorm funciona perfectamente y es capaz de verificar tipos y autocompletar bien. No reconocerá la extensión .jsdoc (que acabo de .jsdoc ), así que .js a .js incluso si el archivo no contiene ninguna declaración de código.