显示未记录的函数参数答案

【问题标题】：Show undocumented function parameters显示未记录的函数参数
【发布时间】：2012-05-04 09:21:16
【问题描述】：

我正在使用 doxygen 生成 C++ 代码的 HTML 文档。不幸的是，doxygen 没有在方法描述中显示未记录的方法参数。例如，使用以下

/**
 * Some method
 * @param p1 Some param
 */
void method(const std::string& p1, const std::string& p2);

方法描述将显示注释和参数p1，但不显示p2。

即使没有明确记录，我如何配置 doxygen 以列出方法描述中的所有参数？

【问题讨论】：

AFAIK 这是不可能的（我可能错了）。参数p2出现在doxygen文档的方法签名中，这还不够吗？如果您希望它也出现在参数列表中，我认为您必须记录它（您可以将文档留空，例如仅使用 \param p2）。
当列出所有参数并且未记录的参数有空白注释（如在 JavaDoc 中）时，它看起来更一致。记录所有参数当然可以解决这个问题，但我可以直接写评论。 ;)

标签： doxygen

【解决方案1】：

这是不可能的。

Doxygen 可以警告您不完整、错误或缺少参数文档。