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++ (26,378 stars) (10,782 forks)batch import
bugzillacheck-requestclang-tidygood first issue

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

Tech stack
cpp
Domain
clitooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C++clang tidy development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue proposes a clang tidy check to replace C style single line block comments with // comments. Implementation requires creating a new check using AST matchers. Review existing checks in clang tidy for patterns, e.g., in clang tools extra/clang tidy/. Special attention needed for the false positive case where /* ...\ */ could become // ...\ and break line continuation. Start by examining the comment related checks and understanding the Lexer or SourceManager APIs for comment detection.