google / google/google-java-format
Support Markdown Documentation Comments (JEP 467, JDK 23)
- Dominant language
- Java
- Stars
- 6.2k
- Forks
- 937
- Avg merge
- 6m
- Merged PRs (30d)
- 3
Description
Consider the following code:
```java
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:
1. The doc comment is split into two lines, but the second line starts with `//` instead of `///`.
2. 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.
Contributor guide
Assessment
This issue has not been assessed yet.