Proporcionar comentarios del código XML
Los comentarios de código son comentarios incluidos en los archivos de código fuente que están a disposición de los usuarios del entorno de desarrollo integrado (IDE) a través de la característica IntelliSense.
[Visual Basic]
Los comentarios de código XML están disponibles en Visual Basic a través del delimitador ''' (tres comillas sencillas). Para obtener más información, vea Cómo: Crear documentación XML en Visual Basic.
[C#, J#]
Puede utilizar la característica de documentación XML para comentar el código. Al anotar tipos y miembros que están definidos en los archivos de código fuente de las soluciones con comentarios de documentación XML, dichos comentarios se mostrarán a través de las características de IntelliSense, como:
Nota
Cuando se comentan métodos parciales, sólo los comentarios en la implementación, no la definición, aparecen en las características de IntelliSense.
Para obtener más información, vea Comentarios de documentación XML (Guía de programación de C#).
[C++]
De forma predeterminada, los comentarios del código fuente que utilizan los delimitadores // o /* se muestran junto a su miembro asociado en la lista Miembros. Para obtener más información, vea C++ Comments y XML Documentation (Visual C++).
A medida que se desplace en la lista, IntelliSense mostrará hasta 12 líneas de comentario en una ventana emergente situada junto al miembro resaltado. Si existe más de un comentario para una función, IntelliSense determina el comentario que mostrará en la lista Miembros en función del lugar en el que aparezca en el código:
IntelliSense muestra primero los comentarios de fin de línea de la declaración. Por ejemplo:
void MyFunction(); //EOL declaration commentsSi IntelliSense no encuentra el tipo de comentario anterior, muestra comentarios que aparezcan directamente encima de la declaración, sin líneas en blanco entre medias. Por ejemplo:
//Before declaration comments void MyFunction();Si no se encuentran los dos tipos de comentario anteriores en el código, IntelliSense muestra los comentarios de fin de línea de la definición. Por ejemplo:
int CMyAppDoc::MyVariable=2; // EOL definition commentsPor último, si en el código no hay ninguno de los tipos de comentario anteriores, IntelliSense muestra comentarios que aparecen directamente encima de la definición, sin líneas en blanco entre medias. Por ejemplo:
//Before definition comments CMyAppDoc::MyFunction() { return; }