llvm/llvm-project

Replace /* ... */ single-line comments with // ... comments

Open

#24,841 opened on Aug 15, 2015

View on GitHub
 (12 comments) (1 reaction) (1 assignee)C++ (10,782 forks)batch import
bugzillacheck-requestclang-tidygood first issue

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description
Bugzilla Link 24467
Version unspecified
OS Windows NT

Extended Description

Detect when C-style /.../ block comments are used to create a single-line comment. Replace those block-style comments with // style comments.

Possible false positives:

/* ....\ */

comments could result in a // comment like this:

// ...\

which would escape the newline and be a problem.

Contributor guide

Research direction
Examine the codebase for existing comment handling in clang tidy or similar tools, then implement a new check to detect single line /* */ comments and replace with //.
Tech stack
ccpp
Domain
compilerstooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80