c++ - 如何确保 C/C++ 代码中不缺少 doxygen 样式的文档注释？

Question

我想对 C/C++ 代码运行某种 linter 或静态代码分析，如果有缺少文档的代码会发出警告，例如没有 doxygen 风格文档注释的函数。换句话说，我想强制执行某些代码标准。我查看了 clang-tidy 和 cppcheck，但没有深入了解。

为了让我更清楚地了解我对 Python 的期望，我习惯了这样的事情:

$ cat test.py 
def answer():
    return 42
$ python3 -m pylint test.py 
************* Module test
test.py:1:0: C0111: Missing module docstring (missing-docstring)
test.py:1:0: C0111: Missing function docstring (missing-docstring)

------------------------------------------------------------------
Your code has been rated at 0.00/10 (previous run: 0.00/10, +0.00)

Answer 1

Clang 有 -Wdocumentation 选项用于静态检查 Doxygen 风格的注释。\见 https://clang.llvm.org/docs/UsersManual.html .

此外，正如@Null 在评论中提到的，doxygen 工具本身会警告某些文档问题。