如何确保C/C ++代码中不会缺少Doxygen式文档评论？

Question

我想在C/C ++代码上运行某种衬里或静态代码分析，如果没有文档丢失的代码，则会发出警告，例如一个没有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

Https：//clang.llvm.org/docs/usersmanual.html

.

另外，正如评论中提到的那样，doxygen工具本身也会警告某些文档问题。
    

我最近遇到了这个问题，我实际上使用了doxygen本身和一个脚本来确保所有文档始终存在。

在doxygen配置文件中，启用以下内容：

-Wdocumentation

Answer 2

现在，当您运行

WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = YES

# Do not throw errors on warning
# otherwise, it will stop on first
# error
WARN_AS_ERROR          = NO

# It will write all warnings to a
# warning file. Make sure to
# add this to your gitignore
WARN_LOGFILE           = doxy.warn

# Optional
QUIET                  = YES

命令时，它将在

doxygen

文件中写入所有错误。

现在，如果doxygen失败，我们将解析它并丢弃错误。这是我使用的Shell脚本（我对PowerShell不了解；所以，无法为Windows提供摘要）：

doxy.warn