[DrJava] [ drjava-Feature Requests-745158 ] Auto-close Comments

[SourceForge.net <no...@so...>]

Feature Requests item #745158, was opened at 2003-05-28 15:30
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=438938&aid=745158&group_id=44253

Category: Definitions (source editor)
Group: Small (< 1 pair-week)
Status: Open
Priority: 5
Submitted By: Peter Centgraf (centgraf)
Assigned to: Nobody/Anonymous (nobody)
Summary: Auto-close Comments

Initial Comment:
Story:

A user is writing the comments for a method (s)he has just defined.  
First comes the open comment tag, then enter.  DrJava recognizes 
this as the start of a comment and automatically inserts the close 
tag, leaving something like this:

[indent]/** 
[indent] * 
[indent] */

The cursor should be positioned at the end of the middle line, ready 
to accept the comment text.

Notes:

Right now we provide the first step, adding the indentation and first 
asterick, but this leaves the rest of the document in "commented 
out" state.  It would be cleaner to add the close tag immediately and 
preserve the state of the text following the comment.

We may want to detect whether there is a stranded "middle" of a 
comment for which the user is attempting to add an proper open 
tag, e.g.

[user adds "/**" tag here]
[indent] * 
[indent] */

In this situation, we may not want to immediately close off the tag.  
This is debatable, though.

Another issue is whether we should behave this way for ordinary 
multiline comments (starting with "/*") or just for documentation 
comments.  Consistency might be an advantage here, but this might 
also annoy users who are attempting to comment out a block of 
code.  Then again, java itself doesn't lend itself well to this style of 
block commenting, since another comment could prematurely close 
the whole block.  Given this situation, perhaps consistency with 
documentation comments is best.  Again, comments are welcome.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=438938&aid=745158&group_id=44253