Draft JEP for upcoming work on snippets

Jonathan Gibbons jonathan.gibbons at oracle.com
Sat Jan 23 00:50:17 UTC 2021


FYI,

JDK-8201533: Enhanced javadoc support for code samples (snippets)

This is a draft JEP that describes a proposal for a new doc comment tag 
to replace the use of `<pre>{@code ...}</pre>` to include code samples 
(also known as "snippets") in API documentation comments.

Feedback, comments welcome.

-- Jon, on behalf of the JavaDoc team

https://bugs.openjdk.java.net/browse/JDK-8201533




More information about the javadoc-dev mailing list