“Fix Doc Comment” Action is Available
A new action for code documentation maniacs, called Fix doc comment, has just been cooked at the JetBrains’ oven.
Please follow the recipe:
- Find or create a stub doc comment.
- Fix documentation problems quickly whenever you wish.
The first case, when you may need the new action, is rather simple. Call it, when a caret is somewhere within a class, field or method, which does not have a doc comment. A doc comment stub will be added, and the caret will be moved to proper position for entering a comment.
The second use-case for the new action, is to fix an existing documentation problems. For example, the signature of some method has been changed, and the doc comment is valid anymore. We have an inspection, which allows to fix such problems one-by-one. It adds missing @param tag, return outdated @return, etc. The new action can fix these problems at once.
We hope the new action will save your time, when you document your code or just fix the problems.
Currently the new action is available only for Java. But we hope to implement it soon for other languages too.
Subscribe to Blog updates
Thanks, we've got you!
The What, Why, and How of JPA Buddy in IntelliJ IDEA
Master JPA entity management with JPA Buddy in IntelliJ IDEA! Our latest article shows you how to simplify your workflow and reduce boilerplate code.
The Best of IntelliJ IDEA’s HTTP Client
In today's fast-paced tech world, easy and efficient management of web services and APIs is crucial. That's where IntelliJ IDEA's HTTP Client steps in, turning complex HTTP requests into a walk in the park. The HTTP Client is a feature-rich, text-based tool in IntelliJ IDEA Ultimate. It seamlessl…
Import Postman Collections to the HTTP Client
We know that many of you use Postman collections and want to stay in the flow while working with them. This means staying inside IntelliJ IDEA and not switching to a different app. Great news! You can now effortlessly transform Postman collections into .http and use them in the HTTP Client …
What’s New in IntelliJ IDEA 2023.1 for Spring Developers
The IntelliJ IDEA 2023.1 release came packed with updates for Spring. This blog post will highlight the most noticeable changes, including full support for Lombok, a reworked Spring tool window, navigation for Spring Security rules, Spring Security 6 support, and more. Remember that these featur…