Add a textual comment.

Synopsis

Declared in <llvm/MC/MCStreamer.h>

virtual
void
AddComment(
    Twine const& T,
    bool EOL = true);

Description

Typically for comments that can be emitted to the generated .s file if applicable as a QoI issue to make the output of the compiler more readable. This only affects the MCAsmStreamer, and only when verbose assembly output is enabled.

If the comment includes embedded 's, they will each get the comment prefix as appropriate. The added comment should not end with a . By default, each comment is terminated with an end of line, i.e. the EOL param is set to true by default. If one prefers not to end the comment with a new line then the EOL param should be passed with a false value.

Parameters

Name

Description

T

‐ Comment text; should not end with a newline.

EOL

‐ True to terminate the comment with a newline.

Created with MrDocs