clang-format - 强制 clang-format 尊重 doxygen block 注释

Question

我在 C/C++ 代码中使用长块 C 风格的 Doxygen 注释。这是在 http://www.doxygen.nl/manual/docblocks.html 上列出的样式 #4看起来像这样(用完 80 个字符)...

/**************************************************************************//**
* \file
* \date   2017-01-02
* \author Alex Hogen
******************************************************************************/

如果我对此运行 clang-format，它 插入一个空格 在两个正斜杠之间，所以它看起来像这样愚蠢......

/**************************************************************************/ /**
* \file
* \date   2017-01-02
* \author Alex Hogen
******************************************************************************/

我有 SpacesBeforeTrailingComments设置为2，所以这不是问题。

试过 CommentPragmas正则表达式 \/\*+\/\/\*+ .

试过 CommentPragmas正则表达式 /\*(.+\n.+)+\*/

我试过设置 ReflowComments至 false

......但这些事情都没有奏效。

我知道这个块中有两条注释，但我在同一行找不到任何 clang-format 参数寻址块注释。如何阻止 clang-format 插入这个空间？

我不想通过 disabling clang-format 来解决这个问题对于每个 Doxygen 评论块。这看起来很荒谬。

有什么好的建议吗？ :-)

Answer 1

在您的 .clang-format文件:

CommentPragmas:  '^\\.+'

这将使它不会格式化以反斜杠开头后跟一个单词的注释行。即使在 doxygen 注释之前有一个星号，这也有效，因为 clang-format 自动忽略每个注释行开头的星号和空格。