When Javadoc formatting is disabled, don't change javadoc so much
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
Direção de pesquisa
Comece rastreando a opção existente --skip-javadoc-formatting e o caminho de formatação de Javadoc. Compare o comportamento atual com o modo totalmente desabilitado solicitado e com as opções de formatação seletiva propostas; «done» deve incluir uma semântica de opções claramente definida que preserve o conteúdo e a indentação de Javadoc quando a formatação estiver desabilitada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Javadoc formatting regularly gives undesired results and lags behind in its support for both Javadoc (esp. {@snippet ...}) and HTML (e.g. elements such as <section>, <article>, <figure>, <figcaption>, ... aren't properly supported, nor is wrapping a "block" with an <a> element, etc.).
With --skip-javadoc-formatting, the result is unusable as well, because indentation is still removed.
So because of the poor Javadoc formatting, and the inability to disable it altogether, it's impractical to format my Java code with GJF.
I propose to at least provide an option to disable Javadoc formatting altogether (i.e. not even adding asterisks or doing any alignment/indentation changes). Either by updating the semantics of --skip-javadoc-formatting, or by introducing a new option (e.g. --disable-javadoc-formatting).
It would also be helpful to have an option where GJF only formats pure Javadoc (i.e. anything within {@... } and lines that start with a tag) and leaves anything else untouched (with an additional option to specify tags to exclude, such as @snippet while it's unsupported).
- Linguagem predominante
- Java
- Estrelas
- 6.2k
- Forks
- 936
- Merge médio
- 6min
- PRs com merge (30d)
- 2
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de google/google-java-format
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
google/google-java-format#1094 · 1 comentário ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 55/100
google/google-java-format#1439 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 62/100
google/google-java-format#1436 · 2 comentários ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 48/100
google/google-java-format#1428 · 4 comentários ·
-
Eclipse
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
google/google-java-format#1417 ·
Todas as issues de google/google-java-format
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Content
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
RunestoneInteractive/rs#1559 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
inu-appcenter/memorIN-backend#298 ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
opendataloader-project/opendataloader-pdf#757 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
redhat-developer/intellij-quarkus#1626 ·