Skip to content

Fix formatting markdown java code block with empty lines #5267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jjohnstn merged 1 commit into from
Aug 5, 2026
+30 −1
Merged

Fix formatting markdown java code block with empty lines #5267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions ....tests.model/src/org/eclipse/jdt/core/tests/formatter/FormatterMarkdownCommentsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,34 @@ class Foo {
formatSource(input, expected);
}

public void testMarkdownFencedCodeBlock2() throws JavaModelException {
setComplianceLevel(CompilerOptions.VERSION_23);
String input = """
/// A markdown comment, with a codeblock.
/// ```java
/// void foo() {
///
/// System.out.println("Hello, World!"); // 2 spaces indented
///
/// }
/// ```
class Foo { }
""";
String expected = """
/// A markdown comment, with a codeblock.
/// ```java
/// void foo() {
///
/// System.out.println("Hello, World!"); // 2 spaces indented
///
/// }
/// ```
class Foo {
}
""";
formatSource(input, expected);
}

public void testMarkdownFencedCodeBlockWithTilde() throws JavaModelException {
setComplianceLevel(CompilerOptions.VERSION_23);
String input = """
Expand Down
3 changes: 2 additions & 1 deletion org.eclipse.jdt.core/formatter/org/eclipse/jdt/internal/formatter/CommentsPreparator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1691,7 +1691,8 @@ private void getCodeToFormat(int startPos, int endPos, StringBuilder sb, int[] p
if (c == '*')
lineStart = (this.ctm.charAt(i + 1) == ' ') ? i + 2 : i + 1;
if (c == '/' && isMarkdown)
lineStart = ((this.ctm.charAt(i + 1) == '/') && (this.ctm.charAt(i + 2) == '/')) ? i + 4
lineStart = ((this.ctm.charAt(i + 1) == '/') && (this.ctm.charAt(i + 2) == '/'))
? (this.ctm.charAt(i + 3) == ' ' ? i + 4 : i + 3)
: i + 1;
break;
}
Expand Down
Loading