Bug 76646 - [misc] Better or no default comments
Summary: [misc] Better or no default comments
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Text (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-Text-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-10-20 07:52 EDT by Omry Yadan CLA
Modified: 2013-07-19 09:43 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Omry Yadan CLA 2004-10-20 07:52:23 EDT
Currently, By default, there are some 'todo' templates, which explain how to
change them, like :
 * To change the template for this generated type comment go to
 * Window>Preferences>Java>Code Generation>Code and Comments
A quick google search for Window>Preferences>Java>Code Generation>Code and
Comments gets over 40,000 hits.
this shows something quite simple:
although its easy to change, most users do not bother to.
they simply ignore it, sometimes not even noticing it at all.
so, in practice, although well intended, this comments crap the source code of
many people, who are too lazy/blind/indifferent to fix it, and upseting
co-workers who are not indifferent to these comments.
after the 10th time of trying to educate lazy co-workers to fix it, I figured
that a better solution will be not to put it there in the first place.
so, I ask you to re-consider the placement of such todo notes in default
templates in future releases of eclipse.
Comment 1 Dani Megert CLA 2004-10-20 12:11:50 EDT
I also hate seeing those things in shipped code. A possible solution would be to
add no comments per default but have Quick Assists to:
- enable adding of comments (maybe with a wizard to configure them first)
- add a comment

What do you think Martin?
Comment 2 Markus Keller CLA 2004-12-15 10:19:00 EST
+1 for removing the sentence pointing to a preference page.
+1 for not adding comments by default.
Comment 3 Robin Rosenberg CLA 2013-07-19 09:43:18 EDT
The settings can be per project, so it's easy to make them disappear once you've created a project.