2011-10-31 5 views
14

No es¿Cómo escribir comentarios/documentación para variables/campos/listas en VS 2010?

///<summary> 
///This is summary for some class or method 
///</summary> 

documentación para las clases o métodos. ¿Pero cómo escribir esto para variables simples o listas?

Uso Visual Studio 2010 y cuando me cierne sobre alguna lista, propiedad o lo que alguna vez me gustaría ver algún tipo de resumen (en esa pequeña información sobre herramientas) he escrito algo específico.

///<doc> 
///always use this list! 
List<String> beer = new List<String>(); 

edición: bien, hemos descubierto, que funciona como de costumbre, siempre y comentario u en su clase, pero fuera de un método o una función !!

¿Alguna forma de documentar/comentar dentro de un método también?

public class BeerForall 
{ 
    /// <summary> 
    /// it works here 
    /// </summary> 
    public List<String> beer = new List<string>(); 

    public String giveBeer() 
    { 
     /// is not working, u can not comment 
     /// <summary> 
     /// test test, not working 
     /// </summary> 
     List<String> moreBeer = new List<string>(); 

     return "beer"; 
    } 
} 
+3

Funciona bien para todas las propiedades y campos, no es probable que funcione para cualquier variable en una función? – gideon

+0

maldición, tienes razón:/no funciona en un método. En una clase puede documentar como de costumbre, pero dentro de un método/función no funciona. ¿Alguna forma de hacerlo funcionar? – Gero

+0

Sí, funciona por métodos? ¿Dónde está definido su método y de dónde lo está llamando? Si se muestra en intellisense, los comentarios se mostrarán. Podría tomar algunos segundos cargarlo alguna vez. – gideon

Respuesta

10

Parece que funciona perfectamente bien en Visual Studio 2010. Definí una Lista como un campo privado con un comentario dentro de mi clase MainForm.

No funcionarán para las variables locales definidas dentro de las funciones.

enter image description here

+0

en la clase en sí funciona. pero intenta documentar algo dentro de un método. vea mi primera entrada editada – Gero

+3

Sí, eso es lo que dije en mi primer comentario a su pregunta, no puede documentar las variables definidas dentro de un método en sí mismo. – gideon

+0

¡bien edite su publicación aquí y puedo marcarlo! – Gero

0

Del mismo modo que escribe el resumen para las clases y métodos, trabaje para las variables.

0

Puede agregar dichos comentarios XML documentation a cualquier miembro de la clase de la clase, no dentro de un miembro (método, propiedad, etc.).

5

Por lo que yo sé, la adición de comentarios para IntelliSense no funciona para las variables locales declaradas dentro de las funciones. Si hicieras que tu lista local fuera una variable de instancia de la clase, podrías hacer esto.

12

Como han mencionado otros, no se puede obtener IntelliSense para los vars locales. Sin embargo: si su función es tan grande que un comentario "normal" no es lo suficientemente cerca como para leer cerca del lugar donde está usando la var, entonces la corrección correcta es refactorizar la función - dividirla en múltiples, métodos más pequeños, con menos vars. No creo que esta característica exista, ya que solo serviría para facilitar la escritura de funciones excesivamente grandes.

+1

Quizás no esté viendo cómo eso podría ser útil. Te sugiero que eches un vistazo a doxygen. En doxygen, cualquier documentación que pueda escribir en un comentario antes de la función, también puede escribir dentro de la función. Eso le permite continuar, por ejemplo, la sección de comentarios con una explicación del algoritmo, el código de entrelazado y la documentación en un estilo que está muy cerca de la programación literal. Algunas piezas de código se benefician mucho. – migle

+0

El código de refactorización es bueno, pero no veo cómo quitarle herramientas al programador es una "característica" útil para aplicar buenas prácticas de codificación. FWIW No creo que esté funcionando, quien escribió la base de código que estoy manteniendo ahora no dijo "oh gee, no puedo comentar las variables locales, así que eso significa que voy a codificar mejor ahora". Además, hipotéticamente, si esto realmente se dejó de lado para fomentar un buen estilo de codificación, ¿por qué los comentarios Intellisense de variables locales funcionan para C/C++ pero no para C# en VS2013? – jrh

+2

"No creo que esta característica deba existir, ya que solo serviría para facilitar la escritura de funciones excesivamente grandes". Creo que debería existir a menos que puedas reescribir más de 30k + líneas de código de backend con las que tengo que lidiar. –

-1

Editar: parece que <var> solo es compatible con JavaScript.

A partir de Visual Studio 2012, puede agregar esta documentación mediante el elemento <var>.

Aquí está la documentación de Microsoft en él:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx

+0

Lamentablemente, la documentación vinculada solo se aplica a Javascript. Intenté usar '' en una variable local como tal, sin efecto. –

Cuestiones relacionadas