llvm / llvm/llvm-project

[clang-tidy] Add comment format configuration to `bugprone-argument-comment`

Open
#168,062 6 comments 1 reaction 0 assignees View on GitHub
clang-tidy enhancement
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

TL;DR: Add `bugprone-argument-comment.CommentTemplate: ` configuration option.

It would be nice if users could have more control over the comment format that `clang-tidy` considers to be an argument comment. Common use-cases seen in the wild include:

- `/* parameter_name */ arg`
- `arg /* parameter_name */`
- `/* parameter_name = */ arg`

Currently only (exactly) `/*paramter_name=*/` works, so the above are not checked for correctness.

Contributor guide

Open the contributing guide

Research direction

Start with the clang-tidy bugprone-argument-comment check and trace how its current argument-comment format is recognized and configured. Compare the existing behavior with the three formats in the issue, then verify that a CommentTemplate regex controls which comments are checked and that the check's relevant tests cover the supported forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.