redhat-developer / redhat-developer/vscode-java
[Formatter Bug] Comments of the parameters are indented incorrectly
Open
Nobody has claimed this yet.
bug
formatter
ux
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
Expected Result
(Image Format)

(Text Format)
* @param test
* test test test
* @param test
* test test test test
Current Result
(Image Format)

(Text Format)
* @param test
* test test test
* @param test
* test test test test
Formatter XML Config
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<profiles version="12">
<profile kind="CodeFormatterProfile" name="Test Formatter" version="12">
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
<setting id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments" value="true"/>
</profile>
</profiles>
Environment
- Operating System: Windows 10
- JDK version: jdk-14.0.2.12-hotspot
- Visual Studio Code version: 1.53.0-insider
- Java extension version: 0.74.0
Additional Informations
I can't update the XML profile version because the project need to support old eclipse versions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the formatter output with the supplied Formatter XML Config and compare the current and expected indentation for Javadoc @param comments. Done means formatted parameter descriptions use the expected indentation rather than the extra spacing shown in the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, vscode
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100