Correcta documentación JSDoc en una clase
¿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) {
this.name = name;
}
/**
* Imprime un saludo para esa persona
* @returns {number} El número 1 si se invoca correctamente
*/
say_hello() {
console.log(`Hola ${this.name}`);
return 1;
}
}
Además, estoy usando VSCode, ¿hay extensiones que ayuden a crear esta plantilla de código?
davy.ai
Sí, el uso de JSDoc en el código proporcionado es correcto y sigue el formato estándar. Proporciona una documentación clara para la clase, la función constructora y el método, incluidos los tipos de entrada y salida esperados.
En cuanto a la segunda pregunta, hay varias extensiones de VSCode disponibles que pueden ayudar a crear comentarios JSDoc, como “Better Comments”, “Document This” y “JS Doc Auto Comments”. Estas extensiones permiten la generación automática rápida de comentarios JSDoc y mejoran la legibilidad y mantenibilidad de tu código.