Sdílet prostřednictvím


comment (C/C++)

Umístí do souboru objektů nebo spustitelného souboru záznam komentáře.

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

Poznámky

Identifikátor comment-type je jedním z předdefinovaných identifikátorů popsaných níže, který určuje typ záznamu komentáře.Nepovinný parametr commentstring je řetězcový literál poskytující dodatečné informace pro některé typy komentáře.Jelikož je parametr commentstring řetězcovým literálem, dodržuje všechna pravidla řetězcových literálů s ohledem na řídící znaky, vložené uvozovky (") a zřetězení.

  • compiler
    Umístí do souboru objektů název a číslo verze kompilátoru.Linker tento záznam komentáře ignoruje.Zadáte-li pro tento typ záznamu parametr commentstring, kompilátor vygeneruje upozornění.

  • exestr
    Umístí parametr commentstring do souboru objektů.Během propojování je tento řetězec umístěn do spustitelného souboru.Řetězec není při načítání spustitelného souboru načítán do paměti. Lze jej však najít programem, který v souborech vyhledává tisknutelné řetězce.Jedním z možných použití tohoto typu záznamu komentáře je vložení čísla verze nebo obdobné informace do spustitelného souboru.

    Typ exestr je zastaralý a v budoucí verzi bude odstraněn. Linker tento záznam komentáře nezpracovává.

  • lib
    Umístí záznam o vyhledávání knihoven do souboru objektů.Tento typ komentáře musí být doprovázen parametrem commentstring obsahujícím název (a případně cestu) knihovny, kterou má linker vyhledat.Název knihovny se řídí výchozími záznamy o vyhledávání knihoven v souboru objektů. Linker tuto knihovnu vyhledává stejně, jako kdyby byla jmenována v příkazovém řádku, pakliže knihovna není určena přepínačem /nodefaultlib.Do jednoho zdrojového souboru lze umístit několik záznamů o vyhledávání knihoven. Záznamy se v souboru objektů zobrazí ve stejném pořadí, v jakém jsou nalezeny ve zdrojovém souboru.

    Pokud na pořadí výchozí a přidané knihovny záleží, lze kompilací s přepínačem /Zl zabránit umístění názvu výchozí knihovny do modulu objektů.Poté lze pomocí druhé direktivy pragma komentáře vložit název výchozí knihovny za přidanou knihovnu.Komentáře uvedené pomocí těchto direktiv pragma se v modulu objektů zobrazí ve stejném pořadí, v jakém se vyskytují ve zdrojovém kódu.

  • linker
    Umístí možnost linkeru do souboru objektů.Pomocí tohoto identifikátoru comment-type lze zadat možnost linkeru namísto jejího předání v příkazovém řádku nebo zadávání ve vývojovém prostředí.Lze například vynutit zahrnutí symbolu zadáním možnosti /include:

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

    Identifikátoru linker lze předat pouze následující možnosti linkeru (comment-type):

  • user
    Umístí obecný komentář do souboru objektů.Parametr commentstring obsahuje text komentáře.Linker tento záznam komentáře ignoruje.

Vlivem následující direktivy pragma linker při propojování vyhledá knihovnu EMAPI.LIB.Linker prohledá nejprve aktuální pracovní adresář a poté cestu zadanou v proměnné prostředí LIB.

#pragma comment( lib, "emapi" )

Vlivem následující direktivy pragma kompilátor umístí název a číslo verze kompilátoru do souboru objektů:

#pragma comment( compiler )

[!POZNÁMKA]

U komentářů přijímající parametr commentstring lze všude tam, kde by byl použit řetězcový literál, použít makro za předpokladu, že je toto makro rozbaleno na řetězcový literál.Lze také spojovat libovolnou kombinaci řetězcových literálů a maker, která jsou rozbalována na řetězcové literály.Například následující příkaz je přípustný:

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

Viz také

Referenční dokumentace

Direktivy Pragma a klíčové slovo __Pragma