This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 255467 - Turning JavaDoc formatting off regresses from pre JavaDoc formatting versions (7.1?)
Summary: Turning JavaDoc formatting off regresses from pre JavaDoc formatting versions...
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Editor (show other bugs)
Version: 8.0.2
Hardware: All All
: P3 normal (vote)
Assignee: Dusan Balek
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-09-22 03:34 UTC by brettryan
Modified: 2015-09-22 05:06 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description brettryan 2015-09-22 03:34:25 UTC
Comment formatting has been a great addition to NetBeans, however; it's formatting rules are too restrictive and when turned off is a regression to the pre-formatting days. I can't remember when comment formatting was introduced (7.1?), however; when it was introduced turning it off will now require more work to provide properly formatted JavaDoc.


As an example, suppose you have the interface method:

  String test(String arg);

Now if you type the following where the insert cursor is the underscore:

  /**_
  String test(String arg);

Then press [Return] you end up with:

  /**
  _    
  @param arg
  @return 
  */

Prior to javadoc formatting you would at least end up with a properly formatted comment block but no tags:

  /**
   * _
   */

I propose that when formatting is turned off that the following rules still remain:

 * A leading star is inserted and aligned to the star at the top of the comment
 * A space is inserted after the star.
 * Turn off, or provide the ability to turn off inserting all @tags.

FYI my reasoning why I don't use JavaDoc formatting is because of [bug:255462] [1]

 [1]: https://netbeans.org/bugzilla/show_bug.cgi?id=255462