llvm-project/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst

21 lines
480 B
ReStructuredText

.. title:: clang-tidy - misc-argument-comment
misc-argument-comment
=====================
Checks that argument comments match parameter names.
The check understands argument comments in the form ``/*parameter_name=*/``
that are placed right before the argument.
.. code:: c++
void f(bool foo);
...
f(/*bar=*/true);
// warning: argument name 'bar' in comment does not match parameter name 'foo'
The check tries to detect typos and suggest automated fixes for them.