Question

我认为代码应尽可能自我记录;实体（变量，类，......）的目的应该从它们的名称和/或类型中清楚。在这种自我文档充分的情况下，添加明确的文档会分散注意力，应该避免，我相信。

例如，在函数

中

int max(int a, int b);

确实没有必要记录论点;从签名中可以清楚地看出它们的意思。

当然，自我记录并不总是完全可能的，并且有些函数的参数需要明确的文档。

不幸的是，doxygen会针对未记录的参数发出警告。乍一看，似乎WARN_NO_PARAMDOC配置选项可以提供帮助。但是，如果所有参数未记录，它将仅禁用警告。如果有人记录在案，有些则没有，doxygen会发出警告。

所以，我有几个问题：