Support Markdown Documentation Comments (JEP 467, JDK 23)
@eamonnmcmanus is already working on this.
Since Mar 15, 2026.
Assessment
This issue has not been assessed yet.
Description
Consider the following code:
import java.nio.ByteBuffer;
interface BufferAllocator {
/// Returns a lease for a [ByteBuffer] with at least the specified [capacity][ByteBuffer#capacity].
LeasedByteBuffer getByteBuffer(long minCapacity);
}
Formatting the above code causes the following issues:
- The doc comment is split into two lines, but the second line starts with
//instead of///. - The import statement is removed, breaking the links.
Disabling Javadoc formatting doesn't prevent either issue.
The only workaround I could find was to disable google-java-format.
Tested with JDK 23 and google-java-format 1.24.0.
- Dominant language
- Java
- Stars
- 6.2k
- Forks
- 936
- Avg merge
- 6m
- Merged PRs (30d)
- 2
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from google/google-java-format
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
google/google-java-format#1094 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
google/google-java-format#1439 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
google/google-java-format#1436 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
google/google-java-format#1428 · 4 comments ·
-
Eclipse
Difficulty 3/5 1-2 days Newbie friendliness 55/100
google/google-java-format#1417 ·
All issues in google/google-java-format
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
component/zeebe kind/bug
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
UniversalMediaServer/UniversalMediaServer#6356 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
refinedmods/refinedstorage2#1414 · 1 comment ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
yegor256/rultor-image#76 · 1 comment ·