Class MarkdownDocumentationCommentsNotes

java.lang.Object
net.jrodolfo.java_evolution.java23.MarkdownDocumentationCommentsNotes
public class MarkdownDocumentationCommentsNotes extends Object
Explains Markdown documentation comments, introduced in Java 23.

Traditional JavaDoc comments often use HTML for structure such as lists and code blocks. Java 23 allows API documentation comments to be written in Markdown, giving developers a lighter alternative that is easier to read in source code.

  • Constructor Details

    • MarkdownDocumentationCommentsNotes

      public MarkdownDocumentationCommentsNotes()

  • Method Details

    • purpose

      public String purpose()
      Explains the documentation problem addressed by the feature.
      Returns:
      a short explanation

    • benefit

      public String benefit()
      Names the practical source-code benefit.
      Returns:
      a short benefit