如何使用 clang 格式在函数之间添加自定义分隔符？

Question

我有一个 C 和 C++ 代码库，我使用 clang 格式对其进行格式化。我想通过以下方式在函数之间放置分隔符来使我的代码易于阅读：

//-----------------------------------------------------------------------------
void func1()
{
    // body
}

//-----------------------------------------------------------------------------
void func2()
{
    // body
}

//-----------------------------------------------------------------------------
void func3()
{
    // body
}

有没有办法在格式化过程中自动添加此分隔线：

//-----------------------------------------------------------------------------

Answer 1

基于当前可用的样式选项，clang-format 没有可以让您这样做的功能。

但是，clang-format 会保留注释，因此您可以手动插入分隔符，并且它们不会被重新格式化或删除。 您还可以向您的函数添加文档注释（例如参见LSST Stack），这不仅在视觉上将它们分开，而且还有其他用途。

如果您仍然需要此功能，您可以 fork clang-format 并自行实现，也可以通过 在 llvm-project 存储库中提交问题来请求它。