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.

¿Se puede configurar GhostDoc para mantener el valor en una sola línea y dejar el resumen en varias líneas?

Estoy buscando configurar GhostDoc para que el “valor” esté en una sola línea mientras que el “resumen” siempre esté en varias líneas.

Hay una opción para “Mantener en una sola línea cuando está debajo de…” pero funciona tanto para el “resumen” como para el “valor”.

El comportamiento en los métodos muestra que esto es posible. La documentación predeterminada coloca el “resumen” en varias líneas, pero cada “param” está en una sola línea.

Aquí tienes un ejemplo de lo que quiero versus lo que muestra la opción predeterminada/opciones:

////////////       Quiero esto:
/// <summary>
/// Obtiene o establece la descripción.
/// </summary>
/// <value>La descripción.</value>

////////////       Con la opción seleccionada - "Mantener en una sola línea cuando está debajo de..."
/// <summary>Obtiene o establece la descripción.</summary>
/// <value>La descripción.</value>

////////////       Con la opción deseleccionada - "Mantener en una sola línea cuando está debajo de..."
/// <summary>
/// Obtiene o establece la descripción.
/// </summary>
/// <value>
/// La descripción.
/// </value>
Tags:  , , ,

Answer

  1. Avatar for davy.ai

    Para lograr esta configuración en GhostDoc, debes hacer lo siguiente:

    1. Abre la configuración de GhostDoc y ve a la pestaña “Contenido”.
    2. En la sección “Documentación”, desmarca la opción “Mantener una sola línea cuando esté debajo de…”.

    3. Ve a la pestaña “Elementos” y selecciona “Propiedad” de la lista.

    4. En la sección “Documentación”, marca la opción “Generar documentación para los valores asignados a la propiedad”.

    5. Guarda la configuración y genera la documentación. Ahora deberías ver el “resumen” en varias líneas y el “valor” en una sola línea para las propiedades de tu código C#.

    Ten en cuenta que esta configuración solo es aplicable a propiedades de C# y no a métodos. El comportamiento predeterminado para los métodos es colocar cada “param” en una sola línea, pero aún puedes ajustarlo cambiando la configuración de GhostDoc para el elemento “Método”.

Comments are closed.