Bug 52117 - [clean up] remove empty comments
Summary: [clean up] remove empty comments
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.0   Edit
Hardware: All All
: P5 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-02-15 21:04 EST by Joakim Erdfelt CLA
Modified: 2008-07-08 03:40 EDT (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Joakim Erdfelt CLA 2004-02-15 21:04:37 EST 
Add an ability of the formatter with javadoc to remove comments that 
contain no words and/or letters.

Such as:
/* ---------------------------- */
/*************************/
/* */
int foo; //

Suggested option:
[ ] remove comments with no body text.
Comment 1 Dani Megert CLA 2004-02-16 03:29:03 EST 
not for 3.0
Comment 2 Dani Megert CLA 2007-06-22 09:59:35 EDT 
Get rid of deprecated state.
Comment 3 Dani Megert CLA 2008-06-18 06:21:55 EDT 
This would rather be a clean up.
Comment 4 Benjamin Muskalla CLA 2008-07-08 03:40:16 EDT 
I don't say that I like comments like

/*************************/

but I saw them in several projects already to group methods for example. Maybe a tradition of developers without quick outline ;)
I think the cleanup should just remove really empty comments (/* */). In addition it could also remove empty javadoc comments like

/**
 *
 *
*/

This could be a good combination together with the missing javadoc warnings as you can always see where javadoc is really missing. Cheating the system by adding empty comments would not work anymore ;)

Just my 2 cents..