2011-03-14 21 views
27

Desde Eclipse Estoy acostumbrado a eso cuando empiezo a escribir un comentario para una clase o método, los parámetros, los tipos de devolución y las excepciones se autogeneran. Pero en VisualStudio 2010 no puedo encontrar algo como esto. ¿Alguna pista sobre cómo lograr eso?¿Cómo generar automáticamente comentarios en Visual Studio 2010 y C#?

+3

Tenga en cuenta que, en C#, las "excepciones" generalmente no se comentan, ya que no están definidas en el nivel de método como en Java ... –

Respuesta

85

La única forma que conozco de hacerlo es en la línea justo encima de su método, simplemente escriba "///" y generará una plantilla de comentarios basada en el método.

+3

Eso me enseñará a escribir mis comentarios antes de escribir el método, por lo ¡que estoy enfocado en lo que intento que el método haga! –

+3

Pero eso no incluye Excepciones. Sería muy bueno si pudiera crear un resumen de todas las excepciones y podríamos eliminar las que atrapemos. Al especificarlos manualmente, a menudo me olvido de comentar algunos de ellos, lo que es horrible, especialmente en bibliotecas usadas por otras personas. –

1

Intente escribir "///" una línea delante de un método. Dime si eso es lo que estás buscando.

5

Utilice "///" en lugar de "//" para comentarios. Por ejemplo, el siguiente comentario fue generado automáticamente por acaba de empezar a escribir "///":

/// <summary> 
/// </summary> 
/// <param name="terms"></param> 
public TVec(IEnumerable<Term> terms) 
{ 
} 
+0

'' 'para cualquiera que desee hacer esto en Visual Basic :) – user2728841

11

GhostDoc es una extensión gratuita que hará esto. Simplemente pulse (de forma predeterminada) Ctrl + D en cualquier lugar dentro de un método, y agregará comentarios de Documentación XML con los valores predeterminados completados (aunque típicamente deberían ser modificados/expandidos).

+2

Solo quiero que sepan: Gratis para uso personal solamente. En caso de que te importe ;-) – schoetbi