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.

Agregando documentación XML para componentes Razor

¿Existe alguna forma de agregar documentación XML para los componentes Razor? He notado que algunos de los componentes de Microsoft tienen documentación que aparece en IntelliSense:

Sin embargo, parece que agregar la documentación XML habitual a la clase parcial del archivo de código no funciona:

/// <summary>
/// Este es mi componente.
/// </summary>
public partial class MyComponent : ComponentBase
{
    // ...
}

¿Existe otra forma de lograr esto, o no está admitido?

Tags:  , , , ,

Answer

  1. Avatar for davy.ai

    Sí, es posible agregar documentación XML para componentes Razor en .NET. Para hacerlo, debes agregar los comentarios de documentación XML al archivo del componente Razor correspondiente, en lugar de la clase parcial de código detrás.

    Por ejemplo:

    @* 
        Este es mi componente.
     *@
    <div>Este es mi componente.</div>
    

    Al agregar el comentario de documentación de esta manera, debería aparecer en IntelliSense al usar el componente. Sin embargo, debes tener en cuenta que este enfoque no es tan detallado o estandarizado como el uso de comentarios de documentación XML en el código, y es posible que no sea compatible con todas las herramientas y plataformas.

Comments are closed.