JSDoc
Resumen
Dynamoose JSDoc Soporte está en etapa beta.
Dynamoose tiene documentación JSDoc para todas las propiedades y funciones expuestas. Esto significa que en editores como VSCode puede ver la documentación de funciones y propiedades a medida que pasa el cursor sobre ellas.
Preguntas frecuentes
¿Qué significa beta en términos de soporte JSDoc?
Soporte Beta JSDoc significa que la documentación podría estar equivocada o faltante. En el caso de que lo notes, por favor envía una solicitud de extracción o problema.
¿Que Soporte JSDoc esté en fase beta significa que no debería usarlo?
NO. Recomendamos usar y probar el soporte JSDoc a pesar de estar en fase beta. Significa que debes ser consciente de que la documentación puede ser incorrecta o incompleta. Si notas algún problema, por favor envía una solicitud de extracción o problema.
¿Debo confiar más en la documentación de JSDoc o en la documentación de Dynamoose?
En el caso de que la documentación de JSDoc y la documentación de Dynamoose no se alineen o den información diferente, siempre debes considerar la documentación de Dynamoose como la fuente principal de la verdad. Si tienes razones para creer que ambos son incorrectos o la documentación de JSDoc es más precisa que la documentación, por favor envía un solicitud de extracción o problema.
¿Qué debo hacer si tengo preguntas adicionales?
- Contactarme
- Únete a nuestro Slack
- Crea un problema en el repositorio Dynamoose