JavaDoc is our source of truth when comes to understanding in depth Java's API, but also an inspiration on how we can document our own code.
Creating code documentation involves writing a combination of custom JavaDoc tags and HTML elements, which can be time-consuming and error-prone due to its complexity.
Hence, let's take a sneak peek at JEP 467 and how Java documentation could be easier to read and maintain thanks to including Markdown syntax in comments.
Links
JEP 467: openjdk.org/jeps/467
CommonMark variant of Markdown: spec.commonmark.org/0.30
GitHub Flavored Markdown: github.github.com/gfm/#tables...
Chapters
0:00 Intro
0:53 Javadoc, JavaDoc, javadoc
2:25 A New Form of Comment
4:13 Syntactical Details and Beyond
6:33 Outro
Tags #Java #JDK #OpenJDK #JavaDoc
Негізгі бет Ғылым және технология JavaDoc Hits the Markdown on Comments - Inside Java Newscast #68
Пікірлер: 48