{"id":317,"date":"2026-03-06T21:02:05","date_gmt":"2026-03-06T21:02:05","guid":{"rendered":"https:\/\/hackcuba.net\/?p=317"},"modified":"2026-03-06T21:02:05","modified_gmt":"2026-03-06T21:02:05","slug":"comentando-c-con-xml","status":"publish","type":"post","link":"https:\/\/hackcuba.net\/?p=317","title":{"rendered":"Comentando C# con XML"},"content":{"rendered":"\n

Aunque muchos de nosotros no acostumbramos a comentar nuestro c\u00f3digo, porque creemos que no vale la pena o nos dejamos arrastrar por la haraganer\u00eda, estamos conscientes que un programa no comentado es un problema colosal a la hora del mantenimiento. En Microsoft, se refieren a comentar como una Best Practice<\/em> para el desarrollo de cualquier tipo de aplicaci\u00f3n. Por tal motivo, el lenguaje insignia de su plataforma .NET incorpora desde su primera versi\u00f3n en Visual Studio .NET 2003, la facilidad de que su IDE se relacione directamente con un estilo particular de comentar c\u00f3digo. Por supuesto, estamos hablando de C# y la documentaci\u00f3n XML.<\/p>\n\n\n\n\n\n\n\n

Aunque para nada son obsoletos los \/\/<\/code> y \/**\/<\/code>, los comentarios XML son usados por el IDE para describirnos, en tiempo real, las caracter\u00edsticas de los m\u00e9todos u objetos comentados cuando en un futuro los estemos utilizando. Recuerden, por ejemplo, como siempre que usamos un objeto X<\/em> y escribimos un punto a continuaci\u00f3n de su identificador (x.<\/code>), enseguida nos muestra una lista de las opciones disponibles, como sus m\u00e9todos, y de estos su tipo de retorno, descripci\u00f3n, par\u00e1metros, etc. Esto sucede porque dichos m\u00e9todos fueron comentados con XML. En la siguiente imagen podemos llevarnos mejor la idea:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Creando comentarios XML:<\/h2>\n\n\n\n

Con XML podemos comentar: clases, delegados, interfaces, campos, eventos, propiedades y m\u00e9todos. La manera de trabajar con todos es, antes de su definici\u00f3n, teclear tres \u00b4\/\u00b4 (\/\/\/<\/code>) y aparecer\u00e1, en dependencia del caso, una estructura en XML a completar.<\/p>\n\n\n\n

Para el caso de un m\u00e9todo string Califica(int nota){}<\/code>, aparecer\u00e1:<\/p>\n\n\n

\n\/\/\/<summary>\n\/\/\/Este m\u00e9todo califica en Excelente, Muy Bien, Bien\u2026\n\/\/\/<\/summary>\n\/\/\/<param name="nota">Nota cuantitativa del estudiante<\/param>\n\/\/\/ <returns>Nota cualitativa<\/returns>\npublic string Califica(int nota)\n<\/pre><\/div>\n\n\n
Seguro se dan cuenta de para qu\u00e9 se utilizan etiquetas como summary<\/code>, param<\/code> y returns<\/code>. Vamos a ver como nos clasifica Jos\u00e9 Antonio Gonz\u00e1lez Seco en su libro \u00abEl lenguaje de programaci\u00f3n C#\u00bb<\/a>, muchas de ellas:<\/p>\n\n\n\n
Etiquetas de uso gen\u00e9rico<\/strong>
\u00c9stas se utilizan para cualquier objeto que tratemos de comentar:<\/p>\n\n\n\n