llvm/llvm-project

Feature Request: Add clang-format setting to disable "*" being added when ReflowComments is used with /* */ comments

Open

#58,710 opened on Oct 31, 2022

View on GitHub
 (16 comments) (0 reactions) (1 assignee)C++ (10,782 forks)batch import
clang-formatgood first issue

Repository metrics

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

Description

Create a .clang-format file with contents

ColumnLimit: 80
ReflowComments: true

with a test.cpp file (in the same folder as the .clang-format file) like

/* erfdfdfdfdfdfd fd fdfd fd fd fd fd fd fd fd fd fd fd fd fd fd fdf df df df df df df df df df df df fd f */
void func()
{
}

Bug: The result is

/* erfdfdfdfdfdfd fd fdfd fd fd fd fd fd fd fd fd fd fd fd fd fd fdf df df df df
 * df df df df df df df fd f */

but we'd like a setting so the result can be

/* erfdfdfdfdfdfd fd fdfd fd fd fd fd fd fd fd fd fd fd fd fd fd fdf df df df df
   df df df df df df df fd f */

Contributor guide

Research direction
Examine the clang format source code, specifically the comment reflow logic in `lib/Format/`, to understand how asterisks are added. Then implement a new option to control this behavior.
Tech stack
cpp
Domain
clitooling
Issue type
Feature
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.
1-2 days
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++clang format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60