redhat-developer / redhat-developer/vscode-java

[Formatter Bug] Comments of the parameters are indented incorrectly

オープン
#1,782 コメント 6 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

bug formatter ux
主要言語
TypeScript
スター
2.3k
フォーク
546
平均マージ
20時間 1分
マージ済み PR(30日)
11

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、提供された Formatter XML Config を使用して formatter の出力を再現し、Javadoc @param コメントの現在のインデントと期待されるインデントを比較します。フォーマットされたパラメーターの説明が、レポートに示されている余分な空白ではなく、期待されるインデントを使用すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, vscode
領域
tooling
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。