From the course: IntelliJ IDEA Community Edition Essential Training
Join today to access over 22,600 courses taught by industry experts or purchase this course individually.
Generate API documentation with JavaDoc
From the course: IntelliJ IDEA Community Edition Essential Training
Generate API documentation with JavaDoc
- [Instructor] Java doc is a tool that's included with the Java Development Kit. You can use Java doc to generate documentation for your application based on comments that you put in your classes, interfaces, and other source code. First, we'll need to add Java doc comments. A Java doc comment starts with a slash and two asterisks and in IntelliJ IDEA, you can type that string and then press Enter or Return. And it will expand. The Java doc comment ends with an asterisk and a slash. And every line in between should have an asterisk at the beginning. You can place a Java doc comment before any symbols. So for example, you can put it before a class name and I'll say this is my startup class and then you can also add one before the main method, Once again, I'll type slash asterisk asterisk and press Enter or Return. And I'll say this is the startup method. And then for your parameters that are auto generated, you can…
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.