How do you modify block comment alignment in Intellij IDEA with Scala?

Question

Currently when Intellij IDEA autocompletes block comments, e.g. typing /**+<return>, IDEA will create a block comment like so:

/** * Comment goes here */

However, scaladoc recommends that block comment bodies are aligned differently:

/** * Comment here */ (Note the whitespace difference).

How is this configured?

score 1 · Answer 1 · answered Aug 22 '18 at 04:20

1

Intellij 2018.2 supports this now by default.

The setting is at Preferences > Editor > Code Style > Scala > ScalaDoc > Use ScalaDoc indent for leading asterisk.

answered Aug 22 '18 at 04:20

sourcedelica

23,940
7
66
74

Works with intellij IDE 2017.3 too. – Knight71 Feb 21 '19 at 10:01

score 0 · Accepted Answer · answered Nov 19 '15 at 22:37

I can't see support for this in IntelliJ; I think if it was there, it would be under Preferences > Editor > Code Style > Java > JavaDoc. Even though it says JavaDoc, changing these settings also affects Scala and ScalaDoc code.

I'd recommend using Scalariform to achieve this. Scalariform is a code formatter that will format you code on compile, regardless of what you type into IntelliJ. It has a setting called placeScaladocAsterisksBeneathSecondAsterisk which is exactly what you want.

How do you modify block comment alignment in Intellij IDEA with Scala?

2 Answers2