746218 - Source Editor should comment a block with // comments

Status: RESOLVED FIXED

(DevTools :: Source Editor, defect)

Description

[Kevin Dangoor]

Some combination of bug 725430 and bug 739192 added the ability to comment/uncomment a line or block of code in the source editor. When you comment a line of code, it adds a // at the beginning of the line. When you select a block of code, it uses /* */.

I just confirmed that both TextMate and Sublime Text use // at the beginning of lines in both cases. The reason can be seen in this test case:

var foo = function() {
    var bar = 27; /* This is my code */
}

foo();


If you comment a block of code that contains /* */ already, that code becomes invalid.

Comment 1

[Mihai Sucan [:msucan]]

Kevin, do you suggest that we drop the use of block comments entirely and only add line comments, in all cases?

Comment 2

[Kevin Dangoor]

Yes, that is what I'm suggesting. It's what other editors do as well.

Comment 3

[Mihai Sucan [:msucan]]

Thanks! Marking this as a tentative to be fixed with bug 759351.

Comment 4

[Rob Campbell [:rc] (:robcee)]

Moving to Source Editor component.

Filter on CHELICERAE.

Comment 5

[Mihai Sucan [:msucan]]

Attachment: proposed patch

Comment 6

[Rob Campbell [:rc] (:robcee)]

Comment on attachment 645434 [details] [diff] [review]
proposed patch

+   *         - allowBlockComment: tells if the code that comments out
+   *         a selection is allowed to use the block comment wrappers. If not,
+   *         you should use the line comment string.

do we need this option at all? No point in complicating things if we're just going to stick with // line comments...

but then I remembered the CSS editor. Looks like it is needed after all.

Comment 7

[Paul Rouget [:paul]]

to land?

Comment 8

[Mihai Sucan [:msucan]]

Paul: all source editor patches wait for:

1. the orion upstream update. bug 759351
2. their owners to finish them up. In this case I do not need to make any patch changes. However I do need to address Rob's review comments for other patches I submitted for review.
3. currently I am prioritizing work on the web console remote debugging support - bug 768096. Source editor work needs to wait.

Thanks!

Comment 9

[Anton Kovalyov (:anton)]

Switch to CodeMirror fixed this.