Skip to content Skip to sidebar Skip to footer

Add Example Usage (markdown?) To Javadocs

Say I have this: Is there a way to add markdown or html to each method, with an example of how to use the method? I am thinking an expanding panel - button says view example and

Solution 1:

There is a library that allows to use Markdown and even PlantUML in Javadocs like this:

/**
* Java Example:
*
* ```java
* @Override
* public void myMethod() {
* }
* ```
*/

Post a Comment for "Add Example Usage (markdown?) To Javadocs"