Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.
Por favor, explique en qué casos se usa @package. He leído la documentación (https://jsdoc.app/tags-package.html) y no está claro qué es en términos de JavaScript. Generalmente, esta etiqueta indica que un símbolo está disponible solo para el código en el mismo directorio que el archivo fuente de este símbolo. Pero ¿qué . . . Read more
Como puedes ver, se utiliza NumberLike, pero no se utiliza el tipo StringLike y me gustaría encontrar todas estas definiciones de tipo no utilizadas en nuestro proyecto. Es un proyecto de Node.js con TypeScript instalado. Aquí está nuestro archivo tsconfig.json: { “compilerOptions”: { “baseUrl”: “.”, “jsx”: “react”, “allowJs”: true, “checkJs”: . . . Read more
Cómo documentar una propiedad/método de un objeto cuando esta propiedad/método se agrega al objeto más tarde, después de que el objeto se haya inicializado? Ejemplo: Digamos que declaro el siguiente objeto. La documentación de ID y name funciona bien: let AppUser = { /** El id del usuario */ ID: . . . Read more
¿Es el siguiente un uso correcto de JSDoc en una clase? El código es trivial, pero estoy más interesado/a en si este es un uso idiomático de ello o si me estoy perdiendo algo: class Person { /** * Crea una Persona * @param {string} name * */ constructor(name) { . . . Read more
Acabo de empezar a aprender JSDoc y el primer obstáculo con el que me he encontrado es cómo indicar que un parámetro de función debe ser válido JSON. Estoy mirando la documentación de @param y no veo: @param {JSON} ¿Cuál es el enfoque correcto en JSDoc para indicar que un . . . Read more