IntelliJ IDEA has a quick-fix that can convert a line comment into a block comment and vice versa.

To add a block comment in IntelliJ IDEA, press ⌥ ⌘ / macOS or Ctrl + Shift + / on Windows and Linux. In this case, using a multi-line comment is our only option no matter how short our comment needs to be.īlock comments are enclosed in slash-asterisk ( /*) and asterisk-slash ( */). There are exceptions like when we need to insert a comment in the middle of the code line. To quickly add a line comment in IntelliJ IDEA, press ⌘ / on macOS or Ctrl + / on Windows and Linux.īlock comments or multi-line comments usually take the form of a paragraph. Single-line comments in Java start with two forward slashes ( //). So, let’s concentrate on clarification comments and TODO comments. Javadocs deserve their own separate blog post as there are so many things to cover.

The best thing about them is that later on you can generate proper API references from these comments with just a few mouse clicks. Here we add quick notes on what can be changed without leaving the IDE.ĭocumentation comments is another type of comments in code. Whenever we notice room for improvement in code, we can leave ourselves, or others, TODO comments. This can be crucial if our properties contain concatenations or variables. properties files if we localize our applications for other countries. In open-source projects, where multiple developers with different backgrounds work on the same thing, getting up to speed using comments can spare you a lot of time trudging through the code.Ĭomments can also be useful if you need to temporarily “hide” a piece of code without actually deleting it. We can leave comments to clarify the code for ourselves, or for other members of the team, if the code is difficult to read or might require some work in future. There are various types of comments in code and not all of them imply that your code smells. So, let’s take a look at how you can comment your code quickly and efficiently. While this is true, if we’re completely honest, we know it isn’t always as easy as that in real life. Professional developers write their code in a way that it is clear and readable not only to them, but to any developers that deal with it in the future – without any comments. After reading the title of this post, many developers might think that it doesn’t make sense.

Macos install intellij idea