Visual studio tiene un generador automático que permite ahorrar muchísimo tiempo. Este crea el código xml automáticamente con solo escribir tres veces el símbolo de comentario.
En C# el símbolo es \ (así que hay que escribir \\\)
En Basic el símbolo es ' (así que hay que tipear ''')
El código no se genera si los símbolos no se tipean antes de una declaración: hay que escribirlos en una linea inmediatamente anterior a las palabras reservadas (por ej, public class, public sub, public function).
También hay que tener en cuenta que si hemos colocado parámetros en una función o método, estos aparecerán en el código autogenerado, por lo tanto, si los modificamos hay que modificar el código autogenerado también (o borrarlo y volver a generarlo).
(En la explicación que sigue faltan los símbolos mayor y menor, pues el editor de blogger no los acepta ni siquiera bajo 'Code'. Supongo que ya sabes que esos símbolos van ahí, pero los he señalado con comillas por las dudas. Si no abes a qué me refiero ni qué es un tag, puedes ver la definición de la wikipedia.)
Utilidad de los códigos más comunes:
-Entre los tags "summary" y "/summary" se explica que clase/método/función declaramos abajo.
-Entre los tags "remarks" y "/remarks" explicamos que es lo que hace la clase/método/función
-Entre "param name="Nombre_Parametro"" y "/param" hablamos de un parámetro de un método o función.
-Entre "exception cref="Nombre_Excepción"" y "/exception" hablamos de las excepciones posibles.
-Entre "return" y "/return" hablamos de la variable que entrega como resultado una función.
También se pueden inventar tags, según nuestras necesidades. Por ej, tag "Revisión" - "/Revisión".
_
Aclaración
Este es un blog de apuntes universitarios. Creado por mí para compartir mis apuntes con ustedes. No es un curso, ni un tutorial. Muchas de las entradas son resúmenes, definiciones y síntesis. La mayoría tienen palabras técnicas.
Debido a esto, he tenido que cerrar los comentarios, espero sepan comprender que no puedo ampliar las más de 100 entradas de este blog ni explicar temas a todas las personas que entran cada día.
Muchas gracias por su atención.
Atte. Malw Dark
Debido a esto, he tenido que cerrar los comentarios, espero sepan comprender que no puedo ampliar las más de 100 entradas de este blog ni explicar temas a todas las personas que entran cada día.
Muchas gracias por su atención.
Atte. Malw Dark