JEP 467: Markdown Documentation Comments

Enable JavaDoc documentation comments to be written in Markdown, making it easier to write and read. The current use of HTML and JavaDoc tags can be tedious for developers. Markdown provides a simpler and more human-readable alternative for documentation comments. By allowing Markdown syntax alongside HTML elements and JavaDoc tags, developers can write concise and well-formatted documentation comments. Markdown also supports links to other program elements and simple tables. The use of Markdown is indicated by /// at the beginning of each line. The content of the Markdown documentation comment is determined by the structure and styling expressed in Markdown syntax, providing a more user-friendly experience for developers.

https://openjdk.org/jeps/467

To top