Compartilhar via


comment (C/C++)

Coloca um registro de comentário em um arquivo de objeto ou executável.

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

Comentários

comment-type é um dos identificadores predefinidos, descritos abaixo, que especifica o tipo de registro do comentário. O commentstring opcional é um literal de cadeia de caracteres que fornece informações adicionais sobre alguns tipos de comentário. Como commentstring é um literal de cadeia de caracteres, ele obedece às regras para literais de cadeia de caracteres em relação aos caracteres de escape, inserido entre aspas (") e concatenação.

  • compiler
    Coloque o nome e o número da versão do compilador no arquivo de objeto. Esse registro de comentário é ignorado pelo vinculador. Se você fornecer um parâmetro commentstring para esse tipo de registro, o compilador gerará um aviso.

  • exestr
    Coloca commentstring no arquivo de objeto. No tempo de vinculação, essa cadeia de caracteres é colocada no arquivo executável. A cadeia de caracteres não será carregada na memória quando o arquivo executável for carregado; no entanto, pode ser encontrada com um programa que localiza cadeias de caracteres imprimíveis em arquivos. Um uso para esse tipo de registro de comentário é inserir um número de versão ou informações semelhantes em um arquivo executável.

    exestr é preterido e será removido em uma versão futura; o vinculador não processa o registro de comentário.

  • lib
    Coloca um registro de pesquisa de biblioteca no arquivo de objeto. Esse tipo de comentário deve ser acompanhado por um parâmetro commentstring que contém o nome (e possivelmente o caminho) da biblioteca que você deseja que o vinculador pesquise. O nome da biblioteca segue os registros de pesquisa de biblioteca padrão no arquivo de objeto; o vinculador procura por essa biblioteca como se você tivesse a nomeado na linha de comando desde que a biblioteca não seja especificada com /nodefaultlib. Você pode colocar vários registros de pesquisa de biblioteca no mesmo arquivo de origem; cada registro aparece no arquivo de objeto na mesma ordem em que é encontrado no arquivo de origem.

    Se a ordem da biblioteca padrão e uma biblioteca adicionada for importante, compile com a opção /Zl evitará que o nome da biblioteca padrão seja colocado no módulo de objeto. Um segundo pragma de comentário em pode ser usado para inserir o nome da biblioteca padrão após a biblioteca adicionada. As bibliotecas listadas com esses pragmas aparecerão no módulo de objeto na mesma ordem que são localizadas no código-fonte.

  • linker
    Coloca uma opção de vinculador no arquivo de objeto. Você pode usar esse tipo de comentário para especificar uma opção de vinculador em vez de passá-la para a linha de comando ou de especificá-la na ambiente de desenvolvimento. Por exemplo, você pode especificar a opção /include para forçar a inclusão de um símbolo:

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

    Apenas as seguintes opções de vinculador (comment-type) estão disponíveis para ser passadas para o identificador do vinculador:

  • user
    Coloca um comentário geral no arquivo de objeto. O parâmetro commentstring contém o texto do comentário. Esse registro de comentário é ignorado pelo vinculador.

O seguinte pragma faz com que o vinculador procure pela biblioteca EMAPI.LIB na vinculação. O vinculador procura primeiro no diretório de trabalho atual e depois no caminho especificado na variável de ambiente LIB.

#pragma comment( lib, "emapi" )

O seguinte pragma faz com que o compilador coloque o nome e o número da versão do compilador no arquivo de objeto:

#pragma comment( compiler )

Dica

Para os comentários que possuem um parâmetro commentstring, você pode usar uma macro em qualquer local onde você usaria um literal de cadeia de caracteres, desde que a macro expanda-se para um literal de cadeia de caracteres.Você também pode concatenar qualquer combinação de literais de cadeia de caracteres e macros que se expandem para literais de cadeias de caracteres.Por exemplo, a seguinte instrução é aceitável:

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

Consulte também

Referência

Diretivas Pragma e a palavra-chave __Pragma