redhat-developer / redhat-developer/vscode-java

[Formatter Bug] Comments of the parameters are indented incorrectly

Abierto
#1,782 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug formatter ux
Lenguaje dominante
TypeScript
Estrellas
2.3k
Forks
546
Merge medio
20 h 1 min
PR fusionados (30 d)
11

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza reproduciendo la salida del formateador con la Formatter XML Config proporcionada y compara la indentación actual y la esperada para los comentarios Javadoc @param. Se considera completado cuando las descripciones de los parámetros formateadas usan la indentación esperada en lugar del espaciado adicional mostrado en el informe.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java, vscode
Área
tooling
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.