comment (C/C++)

Inserta un registro de comentario en un archivo objeto o un archivo ejecutable.

#pragma comment( comment-type [,"commentstring"] )

Comentarios

El comentario-tipo es uno de los identificadores predefinidos, se describe más adelante, que especifica el tipo de registro del comentario.commentstring opcional es un literal de cadena que proporciona información adicional para algunos tipos de comentario.Dado que commentstring es un literal de cadena, obedece todas las reglas para los literales de cadena con respecto a los caracteres de escape, las comillas incrustadas (), y la concatenación.

  • compilador
    Coloca el nombre y el número de versión del compilador en el archivo objeto.Este registro de comentario se omite el vinculador.Si se proporciona un parámetro de commentstring para este tipo de registro, el compilador genera una advertencia.

  • exestr
    coloca commentstring en el archivo objeto.En tiempo de vínculo esta cadena se coloca en el archivo ejecutable.La cadena no se carga en memoria al archivo ejecutable se carga; sin embargo, puede encontrar con un programa que las cadenas imprimibles en archivos.Un uso para este tipo de comentario-registro es insertar un número de versión o información similar en un archivo ejecutable.

    exestr está desusado y se quitará en futuras versiones; el vinculador no procesa el registro del comentario.

  • lib
    Inserta un registro de biblioteca-Buscar en el archivo objeto.Este tipo de comentario debe ser acompañado por un parámetro de commentstring que contiene el nombre (y posiblemente la ruta) de la biblioteca que desea que el vinculador para buscar.El nombre de biblioteca sigue los registros predeterminados de biblioteca-Buscar en el archivo objeto; las búsquedas del vinculador para esta biblioteca como si se hubiera denominado en la línea de comandos con tal de que la biblioteca no se especifica con /nodefaultlib.Puede colocar varios registros de biblioteca-Buscar en el mismo archivo de código fuente; cada registro aparece en el archivo objeto en el mismo orden en el que se encuentra en el archivo de código fuente.

    Si el orden de la biblioteca predeterminada de una biblioteca agregada es importante, la compilación con el modificador /Zl evitará que el nombre de biblioteca predeterminado se sitúe en el módulo de objeto.Un segundo pragma comment se puede utilizar para insertar el nombre de biblioteca predeterminado después de la biblioteca agregada.Las bibliotecas incluidas con estos pragmas aparecerán en el módulo de objetos en el mismo orden en que se encuentran en el código fuente.

  • el vinculador
    coloca opción del vinculador en el archivo objeto.Puede utilizar este comentario-tipo para especificar una opción del vinculador en lugar de pasarla a la línea de comandos o de especificarlo en el entorno de desarrollo.Por ejemplo, puede especificar la opción /include para forzar la inclusión de un símbolo:

    #pragma comment(linker, "/include:__mySymbol")
    

    Sólo las opciones del vinculador siguientes (de comentario-tipo) están disponibles pasar el identificador de vinculación:

  • usuario
    Coloca un comentario general en el archivo objeto.El parámetro de commentstring contiene el texto del comentario.Este registro de comentario se omite el vinculador.

La pragma siguiente hace que el vinculador para buscar la biblioteca de EMAPI.LIB al vincular.Las búsquedas de vinculador primero en el directorio de trabajo actual y en la ruta de acceso especificada en la variable de entorno LIB.

#pragma comment( lib, "emapi" )

La pragma siguiente hace que el compilador facilite el nombre y el número de versión del compilador en el archivo objeto:

#pragma comment( compiler )

[!NOTA]

Para los comentarios que toman un parámetro de commentstring , puede utilizar una macro en cualquier lugar donde utilizaría un literal de cadena, siempre que la macro se expande a un literal de cadena.También puede concatenar cualquier combinación de literales de cadena y macros que se expandan los literales de cadena.Por ejemplo, la siguiente instrucción es aceptable:

#pragma comment( user, "Compiled on " __DATE__ " at " __TIME__ ) 

Vea también

Referencia

Directivas de pragma y la palabra clave de __Pragma