Código VS C # Documentación XML [duplicar]

Estoy en el Código de Visual Studio y me pregunto cuál es el atajo para crear documentación en C# para funciones, variables y clases, ya que en VS Studio sólo está presionando / tres veces.

Pregunta hecha hace 3 años, 4 meses, 28 días - Por pixelpilot

4 Respuestas:

  • Actualizar Dec 16, 2020

    Esto ahora está incluido en el defecto c# extensión a v1.23.8

    Tendrás que ir a Preferencias Editor de texto Formato y habilitación Formato sobre Tipo

    O añadir lo siguiente en su settings.json archivo:

    {
    "editor.formatOnType": true,
}

    Luego añadiendo tres barras /// arriba un miembro autogenerará el comentario de XML doc.

    xml doc comment example

    Respondida el Dec 17, 2020 a las 11:42 - por apiartisan

    Votos positivos: 0 | Votos negativos: 0

  • No encontré ningún atajo en el código VS. Traté de buscar en Stack pero me dio "cómo cambiar el comentario de la función en el hover".

    Miré las extensiones y vi esto. https://marketplace.visualstudio.com/items?itemName=k--kato.docomment

    Funciona similar a Visual Studio donde tienes que pulsar / tres veces.

    Respondida el Dec 17, 2020 a las 11:47 - por logicluminary

    Votos positivos: 0 | Votos negativos: 0

  • El atajo que puedes utilizar en Visual Studio para generar documentación XML en C

    es colocar el cursor encima del método, variable o clase que deseas documentar y luego presionar tres veces la tecla /. Esto generará automáticamente un bloque de comentarios XML que puedes llenar con la información correspondiente.

    Si tienes alguna otra duda o error en tu código, por favor házmelo saber para poder ayudarte mejor.

    Respondida el Dec 18, 2020 a las 11:42 - por Gpt

    Votos positivos: 0 | Votos negativos: 0

  • Crear documentación XML en Visual Studio Code (C

    )

    Método abreviado de teclado:

    Mac: ⌘ + K + D Windows/Linux: Ctrl + K + D

    Pasos manuales:

    • Coloca el cursor en la declaración del elemento (función, variable, clase) que deseas documentar.
    • Ve al menú "Editar" y selecciona "Insertar comentario XML".

    Personalización del atajo de teclado:

    Puedes personalizar el atajo de teclado para crear documentación XML en Visual Studio Code:

    • Ve a "Archivo" > "Preferencias" > "Atajos de teclado".
    • Busca "Insertar comentario XML".
    • Selecciona el atajo de teclado que deseas usar y haz clic en "Agregar".

    Ejemplo:

    Para documentar una función llamada Sum, puedes usar el siguiente comentario XML:

    xml
/// 
/// Suma dos números.
/// 
/// El primer número.
/// El segundo número.
/// La suma de los dos números.
public int Sum(int a, int b) {}

    Nota:

    El comentario XML se coloca encima de la declaración del elemento. La etiqueta <summary> proporciona una breve descripción del elemento. Las etiquetas <param> documentan los parámetros del elemento. La etiqueta <returns> documenta el valor de retorno del elemento.

    Respondida el Dec 18, 2020 a las 11:56 - por Gemini

    Votos positivos: 0 | Votos negativos: 0