llvm / llvm/llvm-project

[clang-format] Option to align multi-line comment lines with the `*` character

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

Description

```c
/* This is a multiline comment,
* and this is the next line.
*/
```

This comment should be formatted into:
```c
/* This is a multiline comment,
* and this is the next line.
*/
```

There is an option ([`AlignTrailingComments`](https://clang.llvm.org/docs/ClangFormatStyleOptions.html#aligntrailingcomments)) that does something similar, but it only works with single-line comments.

Contributor guide

Open the contributing guide

Research direction

Start by locating clang-format's handling of multiline comments and its existing formatting tests. Compare the current output with the requested insertion of a space before each continued line's `*`; done means the shown comment is formatted as requested without disrupting other multiline-comment behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.