redhat-developer / redhat-developer/vscode-java

[Formatter Bug] Comments of the parameters are indented incorrectly

Offen
#1,782 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug formatter ux
Vorherrschende Sprache
TypeScript
Sterne
2.3k
Forks
546
Ø Merge
20 Std. 1 Min.
Gemergte PRs (30 T.)
11

Beschreibung

Expected Result
(Image Format)

image

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

image

(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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Formatter-Ausgabe mit der bereitgestellten Formatter XML Config zu reproduzieren und die aktuelle und erwartete Einrückung für Javadoc @param-Kommentare zu vergleichen. Erledigt ist dies, wenn formatierte Parameterbeschreibungen die erwartete Einrückung statt des im Bericht gezeigten zusätzlichen Abstands verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, vscode
Bereich
tooling
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.