redhat-developer / redhat-developer/vscode-java
Eclipse Formatter settings for comment length ignored
还没有人认领这个 Issue。
- 主要语言
- TypeScript
- 星标
- 2.3k
- 派生
- 546
- 平均合并
- 20 小时 1 分钟
- 30 天内合并 PR
- 11
描述
I have a custom, Eclipse Formatter XML preference file that includes the following Eclipse JDT formatter setting for comment length:
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="120"/>
I have noticed that, when formatting the code using this settings, comments were always formatted to 80 columns, regardless of the value used. When opening > Java: Open Java Formatter Settings with Preview using the Command Palette, and navigating to the comment section, I noticed that the value in Maximum comment line length is set to 80 -- check out the image below. When modifying this value, my XML file is updated to include the following setting:
<setting id="comment_line_length" value="120"/>
It seems that the formatter is picking up its default setting for line length, which is a property name different than the Eclipse JDT Core formatter setting.
Environment
- Operating System: Amazon Linux 2 (running through SSH)
- JDK version: 8
- Visual Studio Code version: the latest (Nov 2023 release)
- Java extension version:
v1.24.0
Steps To Reproduce
- Create an Eclipsed Formatter XML file containing the setting
org.eclipse.jdt.core.formatter.comment.line_lengthwith a value different than80. - Write a comment that goes over
80or the value set for the property above. - Format the code and see the comment being limited to
80despite the value used in the property above.
Current Result
Comments are formatted to the default value set by comment_line_length instead of the value set by org.eclipse.jdt.core.formatter.comment.line_length.
Expected Result
Comments should be formatted using org.eclipse.jdt.core.formatter.comment.line_length when available.
Additional Informations
Likely related to https://github.com/redhat-developer/vscode-java/issues/2798
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
使用 Eclipse Formatter XML 文件和 Java: Open Java Formatter Settings with Preview 命令重现该问题,并比较 org.eclipse.jdt.core.formatter.comment.line_length 与 comment_line_length。跟踪 formatter 设置的加载和应用过程;当存在 Eclipse JDT 值时,注释使用该值(包括不等于 80 的值),即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java, typescript
- 领域
- developer-experience, tooling
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100