From the course: Java 25 for Professionals with Jetbrains AI Assistant
Unlock this course with a free trial
Join today to access over 24,900 courses taught by industry experts.
Enhance JavaDocs with Markdown syntax - Java Tutorial
From the course: Java 25 for Professionals with Jetbrains AI Assistant
Enhance JavaDocs with Markdown syntax
- Save the best for last they say, and I can't speak for all of you, of course, but I really love this new feature. We can now use markdown in Java documentation. If you have no experience with JavaDoc, here's what it used to look like, it had its own syntax. Here we have the original one. We have a Dog with the classic JavaDoc style comments, and you can see all the HTML and all the angle brackets in here. It's been working since forever, it's what we're used to, but it's all of a sudden got a lot prettier. Look, here we have the same Dog class, but then with markdown documentation. It looks so much more beautiful. It's shorter, it's easier to read, and most importantly, there's less angle brackets. Well, let me prove to you this is actually working just as well. Here we have the App class, and here if I hover over Dog, which has the classic documentation style, it looks like this very, readable. And if I hover over…