es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

Escribiendo JSDoc correctamente para WebStorm, React

15 Jul, 2023 Programación

He escrito la siguiente documentación JSDoc, y cuando la veo en la vista renderizada, no parece renderizarse de una manera agradable. El texto fluye todo junto y muchas de las descripciones de las propiedades no aparecen. ¿Alguien puede ver qué estoy haciendo mal?

/**
 * Muestra la estructura del Roster en la página de Reglas y Puntuación.
 *
 * @param {string} [leagueAbbr]
 * Cuando se proporciona, el siguiente texto se añadirá a la descripción:
 *   "y debe incluir jugadores de al menos 2 juegos diferentes de {leagueAbbr}."
 * Si se incluye lineupDescriptionOverride, no se debe utilizar esta propiedad.
 *
 * @param {string} [lineupDescriptionOverride]
 * Proporciona el texto completo de la descripción del lineup.
 * Si se incluye esta propiedad, no se debe usar leagueAbbr.
 *
 * @param {string} [lineupDescriptionAddendum]
 * Proporciona el texto que se agregará después del texto predeterminado ("El Lineup consistirá de... de al menos 2 juegos {leagueAbbr}").
 *
 * @param {Object[]} sections
 * Datos para la estructura de la alineación.
 *
 * @param {number} sections[].count
 * Número de jugadores en la sección.
 *
 * @param {string} sections[].positionHeader
 * Texto que aparecerá encima del icono.
 *
 * @param {string} sections[].positionText
 * Texto que aparecerá debajo del icono.
 *
 * @param {string} [sections[].iconSrc]
 * Proporciona una URL personalizada del icono para la sección.
 *
 * @param {string} iconSrc
 * URL para el icono.
 *
 * @param {string} [playerNamePlural]
 * Proporciona texto para reemplazar el texto predeterminado ("jugadores") en "El Lineup consistirá de # jugadores".
 *
 * @returns {JSX.Element}
 * El componente del roster
 */
Tags:  , ,

Answer

  1. Avatar for davy.ai
    davy.ai

    Hay algunas cosas que se podrían mejorar en este JSDoc para que se vea mejor:

    1. Utilizar puntuación y gramática adecuadas para que el texto sea más legible.
    2. Utilizar espaciado e indentación adecuados para que el código sea más legible.
    3. Asegurarse de que todas las propiedades estén adecuadamente definidas con su tipo y descripción.
    4. Utilizar un formato adecuado para las entidades HTML como ".

    Aquí hay un JSDoc actualizado con estos cambios:

    /**
 * Muestra la estructura de la Lista de jugadores en la página de Reglas y Puntuación.
 *
 * @param {string} [leagueAbbr] - Cuando se proporciona, se agregará el siguiente texto a la descripción: "y deben incluir jugadores de al menos 2 partidos de {leagueAbbr}". Si se incluye lineupDescriptionOverride, no se debe utilizar esta propiedad.
 *
 * @param {string} [lineupDescriptionOverride] - Proporciona toda la descripción de la alineación. Si se incluye esta propiedad, no se debe utilizar leagueAbbr.
 *
 * @param {string} [lineupDescriptionAddendum] - Proporciona texto para agregar después del texto predeterminado ("La alineación consistirá en.... de al menos 2 partidos de {leagueAbbr}").
 *
 * @param {Object[]} sections - Datos para la estructura de la alineación.
 *
 * @param {number} sections[].count - Número de jugadores en la sección.
 *
 * @param {string} sections[].positionHeader - Texto que aparecerá sobre el ícono.
 *
 * @param {string} sections[].positionText - Texto que aparecerá debajo del ícono.
 *
 * @param {string} [sections[].iconSrc] - Proporciona una URL personalizada para el ícono de la sección.
 *
 * @param {string} iconSrc - URL para el ícono.
 *
 * @param {string} [playerNamePlural] - Proporciona texto para reemplazar el texto predeterminado ("jugadores") en "La alineación consistirá en # jugadores".
 *
 * @returns {JSX.Element} - El componente de la lista de jugadores.
 */

    Esto debería verse mejor cuando se visualice en una vista renderizada y debería facilitar el entendimiento del propósito y uso de cada propiedad.

Comments are closed.