CODEWITHSUNDEEP
c++lintclang-format
Joe Sunday
Joe Sunday

Reputation: 178

clang-format breaks lint annotations

We use lint in our codebase at work for C/C++, I'm trying to start integrating clang-format in my workflow as well.

Unfortunately, lint occasionally requires annotations to ignore a specific check, either of the format:

/*lint -[annotation] */

or

//lint -[annotation]

Specifically, if there's a space between the opening token for the comment and 'lint', it doesn't recognize it as an annotation directive. Unfortunately, the default settings I have for clang-format see that as an error and helpfully insert the space.

Is there any way to get clang-format to recognize comments matching that pattern and leave them alone? Right now I'm using 3.4, but could upgrade if needed.

Upvotes: 14

Views: 6701

Answers (2)

MikecheckDev
MikecheckDev

Reputation: 2484

You can disable clang-format for that section of your file by using:

int formatted_code;
// clang-format off
    void    unformatted_code  ;
// clang-format on
void formatted_code_again;

See the Disabling formating on a piece of code section.

Upvotes: 17

John
John

Reputation: 7339

Clang-format has a `CommentPragmas' option that is

A regular expression that describes comments with special meaning, which should not be split into lines or otherwise changed.

When I put the following line in my .clang-format file, my Lint comments remain untouched.

CommentPragmas:  '^lint'

Other comments that still have "lint" in them, but are not Lint comments still get formatted.

Upvotes: 20

Related Questions