Empresas
Empregos
  • Sobre nós
  • Soluções
    • Publicação de vagas
      Publique sua vaga e receba candidatos qualificados em 48h.
    • Avaliações de candidatos
      Mais de 500 testes técnicos e psicológicos, mais anti-fraude.
    • Headhunting
      Busca executiva personalizada do início ao fim.
    • Folha de Pagamento + EOR
      Dispersão de folha e EOR em mais de 15 países da LATAM.
  • Preços
  • Empregos

0

273
Visualizações
¿Cómo documentar que una función constructora genera objetos que tienen qué propiedades (y también métodos)?

Tengo una función constructora y estoy usando JSDoc para documentarla:

 /** * @constructor * @param {String} title The title of the task * @param {Boolean} important Whether the task is important of not */ function Task(title, important) { this.title = title this.important = important // 1 presents to 'unfinished', 2 presents to 'processing', 3 presents to 'finished' this.state = 1 }

La documentación se genera:

ingrese la descripción de la imagen aquí

Pero aquí hay una cosa. Verá en mi función de constructor, tiene una propiedad con el nombre de state , y no hay un uso de parámetro para establecer el valor de la propiedad de state .

Entonces, cuando documento esta función de constructor de Task , no tengo idea de cómo decirles a los lectores que esta función genera objetos que tienen una propiedad de state . Y, por cierto, creo que los desarrolladores cuando lean la documentación, sabrán que los objetos generados por esta función Task tienen el title y las propiedades important porque esas propiedades están documentadas bajo parámetros. Y dado que la propiedad del state no "depende" de ningún parámetro, no sé cómo mostrarlo en la documentación.

about 4 years ago · Juan Pablo Isaza
1 Respostas
Responde à pergunta

0

Agregue una definición de tipo @typedef para sus objetos Task :

 /** * @typedef {object} Task * @property {string} title The title of the task * @property {boolean} important Whether the task is important of not * @property {number} state 1 represents 'unfinished', 2 represents 'processing', 3 represents 'finished' */

y agregue un @returns a la documentación de su función constructora:

 /** * @constructor * @param {String} title The title of the task * @param {Boolean} important Whether the task is important of not * @returns {Task} a task object */ function Task(title, important) { this.title = title this.important = important // 1 presents to 'unfinished', 2 presents to 'processing', 3 presents to 'finished' this.state = 1 }
about 4 years ago · Juan Pablo Isaza Relatório
Responde à pergunta
Encontrar trabalhos remotos

Descubra a nova forma de encontrar um emprego!

melhores empregos
Principais categorias de trabalho
Empresas
Postar vaga Preços Comercial
Jurídico
Termos e Condições Política de privacidade
© 2026 PeakU Inc. All Rights Reserved.
Andres GPT
Recomende algumas ofertas para mim
Preciso de ajuda