Java

Java leads by example regarding documentation: JavaDoc inspires trust in developers through its transparency on each Java API functionality, and the javadoc tool helps developers generate equally great documentation for their APIs and libraries.

In this episode, Ana hosts Jonathan Gibbons, core contributor and maintainer of JDK tools, to discuss JavaDoc/javadoc developments, focusing on markdown in JavaDoc documentation comments.
Given the importance of having code that is as easy to understand as it is functional, Jonathan dives into significant changes in Java’s documentation component and associated tools, how JavaDoc is maintained, code documentation practices, and more.

For more episodes, check out https://inside.java/podcast or the https://www.youtube.com/playlist?list=PLX8CzqL3ArzV_hXbRevwzrXSMcGNzhxiZ playlist

⎯⎯⎯⎯ Resources ⎯⎯⎯⎯
◦ JEP 467 ➱ https://openjdk.org/jeps/467
◦ How to Write Doc Comments for the JavaDoc Tool ➱ https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
◦ Tool guide ➱ https://docs.oracle.com/en/java/javase/23/javadoc/javadoc-guide.pdf
◦ Standard Doclet Specifications ➱ https://docs.oracle.com/en/java/javase/23/docs/specs/javadoc/doc-comment-spec.html
◦ Example of a sealed class graph in JavaDoc ➱ https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/nio/Buffer.html

⎯⎯⎯⎯ More Information ⎯⎯⎯⎯
◦ Inside.Java - News and Views from the Oracle Java Team ➱ https://inside.java
◦ Dev.Java - The Destination for Java Developers ➱ https://dev.java
◦ OpenJDK ➱ https://openjdk.org
◦ Oracle Java ➱ https://www.oracle.com/java/

Tags: #Java #OpenJDK #Podcast