How to configure Javadoc formatting?

Hi there,

I'm eval'ing IntelliJ right now, and I really love it. The only thing
that keeps bugging me is the Javadoc editing support. While I can set
almost any kind of indentation style for the actual code, I haven't
found something comparable for the Javadocs. I don't like the asterisked
style, because colleagues may not use an editor that is aware of them,
so when they have to reformat a modified comment block, that's going to
be a nightmare with all the asterisks in.

My preferred style looks like this:

/** blablalb
Continued lines align this way and don't have a leading
asterisk

@param p And parameter and other @ tags align this way as well.
*/
public void m()
{
...
}

Is there any way I can teach IntelliJ to use this style?

And is there a way to re-flow comment blocks? I've come to love Emacs
for his relowing feature: just hit Esc-q, and the comment looks nicely
again.

TIA,
-- Axel

2 comments

I'd like to renew my question. Does still nobody know how to do this
with IntelliJ?

-- Axel

Axel Uhl wrote:

Hi there,

I'm eval'ing IntelliJ right now, and I really love it. The only thing
that keeps bugging me is the Javadoc editing support. While I can set
almost any kind of indentation style for the actual code, I haven't
found something comparable for the Javadocs. I don't like the asterisked
style, because colleagues may not use an editor that is aware of them,
so when they have to reformat a modified comment block, that's going to
be a nightmare with all the asterisks in.

My preferred style looks like this:

/** blablalb
Continued lines align this way and don't have a leading
asterisk

@param p And parameter and other @ tags align this way as well.
*/
public void m()
{
...
}

Is there any way I can teach IntelliJ to use this style?

And is there a way to re-flow comment blocks? I've come to love Emacs
for his relowing feature: just hit Esc-q, and the comment looks nicely
again.

TIA,
-- Axel


0

I don't like the asterisked
style, because colleagues may not use an editor that is aware of them,
so when they have to reformat a modified comment block, that's going to
be a nightmare with all the asterisks in.


Only with a plugin.
You can look at the sources of Reformat plugin by Timur Zambalayev.
http://www.intellij.org/twiki/bin/view/Main/ReformatPlugin

The plugin calls idea reformat action and afterwards does some reformating
intself.

And is there a way to re-flow comment blocks? I've come to love Emacs
for his relowing feature: just hit Esc-q, and the comment looks nicely
again.


http://www.intellij.org/twiki/bin/view/Main/FreeTextWrapper


0

Please sign in to leave a comment.