New candidate JEP: 467: Markdown Documentation Comments

Remi Forax forax at univ-mlv.fr
Tue Feb 27 21:44:33 UTC 2024


----- Original Message -----
> From: "mark reinhold" <mark.reinhold at oracle.com>
> To: "jonathan gibbons" <jonathan.gibbons at oracle.com>
> Cc: javadoc-dev at openjdk.org, "jdk-dev" <jdk-dev at openjdk.org>
> Sent: Tuesday, February 27, 2024 9:31:17 PM
> Subject: New candidate JEP: 467: Markdown Documentation Comments

Hello,

> https://openjdk.org/jeps/467
> 
>  Summary: Enable JavaDoc documentation comments to be written in
>  Markdown rather than solely in a mixture of HTML and JavaDoc @-tags.

In the section "alternatives", where using the new syntax /// is discussed,
we may want to add a sentence about the fact that Rust, Swift or C# also use /// as doc comment, so it's not a new syntax specific to Java.

> 
> - Mark

regards,
Rémi


More information about the jdk-dev mailing list