llvm / llvm/llvm-project

clang-tidy bugprone-argument-comment check template arguments

Open
#173,045 1 comment 0 reactions 0 assignees View on GitHub
clang-tidy enhancement
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

Catching the problem in the following example would be a useful addition to the `bugprone-argument-comment` rule:

```
template class C {};
int main() {
// Should produce a warning, as order is swapped:
C xxx;
}
```

currently produces no warning:

```
$ clang-tidy --checks=bugprone-argument-comment ./test.cpp
... (no warning printed)
```

Contributor guide

Open the contributing guide

Research direction

Reproduce the example in test.cpp with clang-tidy --checks=bugprone-argument-comment and confirm that swapped template arguments produce no warning. Start by locating the bugprone-argument-comment check implementation and its existing tests; done means the shown template-argument case emits the expected diagnostic without breaking current cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.