[#IDEA-13072] JavaDoc format

IDEA: Feedback

JavaDoc format

Created: 05 Jun 07 01:31 Updated: 09 Apr 08 20:09

Component/s:

Code Formatting and Code Style

Build:

6,180

Description

« Hide

Is it possible to add a new formatting style for JavaDoc comments? I could like to have parameters arranged like below

@param<tab>paramName
<tab><tab><tab>description
@return<tab>return description
@throw<tab>ExceptionName
<tab><tab><tab>description

The format for @throw etc are the same. This format makes it easier to see the JavaDoc comments. The alignment style currently used by the IDEA creates a little problem when the name of the variable is long, which takes away spaces from the description. This is even more so a case for Exceptions which usually have very long names.

All

Comments

Work Log

Change History

Sort Order:

[ Permlink | « Hide ]

Kieron Wilkinson - 27 Nov 07 17:11 - edited

This would be great, but just as long as the tabs can be spaces depending on your configuration.

BTW this seems to be a duplicate of: http://www.jetbrains.net/jira/browse/IDEA-14591

[ Permlink | « Hide ]

Frank Schröder - 09 Apr 08 20:07 - edited

No, it isn't as the description starts on the next line. I'd also like to see it like that:

/**
  * This is a description.
  *
  * @param s
  *      This is the string value that needs to be passed in.
  *
  * @param foo
  *      This is another parameter
  *
  * @return
  *      Something or other.
  */