When Javadoc formatting is disabled, don't change javadoc so much

未关闭

#789 创建于 2022年5月23日 4 条评论 7 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 5/5
预计耗时: 一周以上
新手友好度: 30/100

Issue 类型: 功能
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: java
领域: tooling

调研方向

首先跟踪现有的 --skip-javadoc-formatting 选项和 Javadoc 格式化路径。将其当前行为与所请求的完全禁用模式以及提议的选择性格式化选项进行比较；“done”应包括明确定义的选项语义，以便在禁用格式化时保留 Javadoc 内容和缩进。

由索引模型根据 Issue 内容生成。

描述

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

主要语言: Java
星标: 6.2k
派生: 936
平均合并: 6 分钟
30 天内合并 PR: 3