tipos - ¿Cómo escribir comentarios en C++ que aparecen en Intellisense?

tipos de comentarios en lenguaje c

Question

Estoy programando en C ++ usando Visual Studio 2010 Ultimate. Quiero documentar algunas funciones y quiero que la documentación se muestre en Intellisense.

De acuerdo con MSDN , solo tengo que poner el comentario antes de la declaración o después en la misma línea. Así que probé esto:

// This is a test.
void foo();
void bar() { foo(); }

Cuando muevo el mouse sobre foo() , el comentario no aparece en la información sobre herramientas. También probé:

• ///
• Etiquetas <summary></summary>
• Construyendo con /doc (configurando la opción "Generar archivos de documentación XML" en la configuración del proyecto)

No he tenido suerte hasta ahora. ¿Alguien sabe una manera de hacer que esto funcione?

Answer 1

¡Esto ahora es compatible con VS 2012!

Anteriormente, las etiquetas XML en los comentarios solo se leían en C ++ / CLI, no en C ++ antiguo. VS 2012 ahora trae al menos algo de esto en C ++ regular; está en las Novedades de Visual Studio 2012 y en los documentos de MSDN: Documentación XML (Visual C ++) .

Lo probé con mi propia aplicación en 2012 ultimate, y puedo confirmar que las etiquetas de resumen, para y seealso también están extraídas y formateadas para la información sobre herramientas.

Answer 2

Intente instalar Visual Assist y use el estilo doxigen :

/**
* COMENT OF A CLASS
**/
class Foo
{
public:
/**
* /brief A foo method.
*
* More complete description of foo.
*
* /param i A foo parameter.
* /return An int
*
**/
int fooMethod(int i);
private:
int i; /*!< COMENT OF A MEMBER */
};

Answer 3

No estoy seguro de qué versión de Visual Studio presentó, pero en VS 2015 simplemente puede poner el comentario sobre una function , method , class , struct , union , enum class , namespace o incluso variables individuales (locales también) y se mostrará por Intellisense. Si desea documentar algo de un módulo diferente, debe escribir un comentario en el archivo de encabezado. Ejemplos:

Answer 4

No utilicé VS2010 es demasiados años para recordar si esto funcionó allí o no. Pero lo que he hecho durante años en muchas versiones diferentes de VS es ...:

#pragma region foo(float)
/// <summary> .... </summary>
/// <param name="bar"> .... </param>
/// <returns> .... </returns>
int foo(float bar)
{
// stuff
}
#pragma endregion

En otras palabras, colocando manualmente lo que Visual Studio automaticamente pondrá para el código C # por ti.

Luego, dale al motor Intellisense un minuto más o menos para volver a rastrear el archivo. Hacer una construcción obligará a volver a analizar, por supuesto.

Según recuerdo, esto funciona en la Comunidad VS2010 Express más reciente, pero no recuerdo si funcionó en VS2010 Ultimate.