editor: Add action to toggle block comments#48752

ozacod · 2026-02-09T01:28:51Z

Closes #4751

Testing

Manually tested by comparing the behaviors with vscode.
Those requirements are added to unit tests.

Release Notes:

Added action to toggle block comments

ozacod · 2026-02-09T18:12:11Z

Formatted, ready for rerun.

niekdomi · 2026-02-10T00:02:44Z

I tested this PR and it works quite well 😄.

One thing I realized is, that it may be more intuitive to exit the visual mode (quit selection) after running the block-comment command

Also, do you plan to add keybindings in this PR? E.g., in NeoVim, this one is likely the most popular plugin for block-comments which uses gb.. motion to toggle block comments

ozacod · 2026-02-10T12:09:48Z

I tested this PR and it works quite well 😄.

One thing I realized is, that it may be more intuitive to exit the visual mode (quit selection) after running the block-comment command

Also, do you plan to add keybindings in this PR? E.g., in NeoVim, this one is likely the most popular plugin for block-comments which uses gb.. motion to toggle block comments

I added and tested keybindings for both vim(gb) and the editor(shift + alt + a). Since I rarely use Vim, I would appreciate it if you could test them too.

niekdomi · 2026-02-10T14:04:38Z

List of bugs I could find:

gb$ should comment out from current position to end

expected:

got:

As you can see, the last character ; is not commented out. (off by one error?)
gbc should comment out the whole line with block comments e.g.,

currently, with gbc the cursor just jumps to a certain position, though I don't understand why (likely a bug?)

Otherwise this seems to work quite well, thanks 😄

niekdomi · 2026-02-10T14:18:26Z

I just realized that if there are multiple block comments on the same line, it might uncomment a comment that should not be uncommented. I added a video that explains this better.

expected:

Screencast.From.2026-02-10.15-16-14.mp4

got:

Screencast.From.2026-02-10.15-15-37.mp4

as you can see, I run gbe twice, which should twice comment out from cursor position to end of the word.

ozacod · 2026-02-10T20:43:51Z

@niekdomi Thanks a lot, fixed it for gb$, gbc and gbe.

niekdomi · 2026-02-10T21:09:40Z

There's another bug (I think this wasn't an issue before). running gbj should comment out the current and next line. Though, if the next line is a newline/empty line, zed crashes.

This seems also to happen with gbk which comments out the current line and the one above, though, here zed crashes, if the current line (where the cursor is positioned) is a new line.

ozacod · 2026-02-10T23:17:54Z

There's another bug (I think this wasn't an issue before). running gbj should comment out the current and next line. Though, if the next line is a newline/empty line, zed crashes.

This seems also to happen with gbk which comments out the current line and the one above, though, here zed crashes, if the current line (where the cursor is positioned) is a new line.

Fixed it. I definitely should have run more comprehensive stress tests. Until then, I am switching this PR to draft. I really appreciate your help. Thanks,

ozacod · 2026-02-11T12:05:54Z

Tested following keybindings in vim mode. "gbc, 5gbc, gbe, gbw, gbj, gbk, gb5j, gb$, gb0, gbG, gbgg, gb%", some edge cases too.
Ready for review.

niekdomi · 2026-02-11T12:54:23Z

It looks like the issue in #48752 (comment) is still popping up on my end. Could you double-check if the latest changes went through

ozacod · 2026-02-11T13:59:03Z

It looks like the issue in #48752 (comment) is still popping up on my end. Could you double-check if the latest changes went through

The previous crashes do not occur on my end. "gbj" was not working properly, just fixed it. Same problem still exists for "gcj", added screencast for it. Since "togglecomments" is out of scope for this PR, I plan to address in a separate PR.

after.mov

niekdomi · 2026-02-11T14:43:54Z

Seems like this fix also fixed gbk 🎉. You're right that gcj and gck behave incorrectly in the specific edge case mentioned in #48752 (comment) , though this issue is also on main branch

SomeoneToIgnore

Thank you, seems that we need to test it a bit more, I've also left a few more code-related comments.

…ck_comments

…sion and add Unicode tests

…omment

…s for visual line mode

…ck_comments; handle visual line mode in vim layer

ozacod · 2026-03-27T22:09:55Z

Hi @ConradIrwin,
@SomeoneToIgnore pointed this out in code review. What should be our action here?

I know this is how VSCode has this, but in our case seems that we should use something else as alt-letter would be expected to type letters in macOS?

cc @ConradIrwin for this and the Vim-related part to check out.

ConradIrwin · 2026-03-27T23:03:53Z

@ozacod If you override option-shift-a, then people on a qwerty keyboard lose the ability to type Å. Similar things apply on other layouts (but often worse because many keyboards often require option to type characters in the ascii range – we used to have a binding on option-z, but that's the @ sign on a polish keyboard). https://zed.dev/blog/keyboard-localization has more information.

As toggle comment is cmd-/, maybe this could be cmd-option-/ ? or cmd-k cmd-/ ?

ozacod · 2026-04-02T22:32:31Z

@ozacod If you override option-shift-a, then people on a qwerty keyboard lose the ability to type Å. Similar things apply on other layouts (but often worse because many keyboards often require option to type characters in the ascii range – we used to have a binding on option-z, but that's the @ sign on a polish keyboard). https://zed.dev/blog/keyboard-localization has more information.

As toggle comment is cmd-/, maybe this could be cmd-option-/ ? or cmd-k cmd-/ ?

I have changed keybindings for macOS to cmd-k cmd-/, and for windows and linux to ctrl-k ctrl-/. Should I have kept for linux/windows as is? I am leaving the preference between cmd-option-/ ? or cmd-k cmd-/ ? those to your preference too.

SomeoneToIgnore

Checked with Conrad and seems we're good to move on, thank you for fixing this long-awaited issue!

Closes zed-industries#4751 ## Testing - Manually tested by comparing the behaviors with vscode. - Those requirements are added to unit tests. Release Notes: - Added action to toggle block comments --------- Co-authored-by: ozacod <ozacod@users.noreply.github.com>

Fixes zed-industries#54737. PR zed-industries#48752 added empty-prefix `block_comment` entries to several language configs (Go, C, C++, JSONC, Python, JSX inner) to support the new toggle-block-comments action. In `Editor::rewrap_impl`, the comment-format matcher used `buffer.contains_str_at(indent_end, &config.prefix)` to decide whether the current line is a continuation of a block comment. When the language is configured with an empty prefix, this is true on every line. `//` (and `#`) line comments inside a `comment` override scope were classified as `BlockLine("")` and never reached the line-comment fallback. The result was that the line-comment prefix was not stripped before wrapping and not re-prepended after, embedding `//` markers as text in the wrapped paragraph. Skip the BlockLine arm when the configured prefix is empty so the matcher falls through to `line_comment_prefixes`.

Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content is consistent with the [UI/UX checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable Closes zed-industries#54737. zed-industries#48752 added empty-prefix `block_comment` entries to several language configs (Go, C, C++, JSONC, Python, JSX inner) to support the new toggle-block-comments action. In `Editor::rewrap_impl`, the comment-format matcher used `buffer.contains_str_at(indent_end, &config.prefix)` to decide whether the current line is a continuation of a block comment. When the language is configured with an empty prefix, this is true on every line. `//` (and `#`) line comments inside a `comment` override scope were classified as `BlockLine("")` and never reached the line-comment fallback. The result was that the line-comment prefix was not stripped before wrapping and not re-prepended after, embedding `//` markers as text in the wrapped paragraph. Skip the BlockLine arm when the configured prefix is empty so the matcher falls through to `line_comment_prefixes`. I've included regression tests for both golang (which adds a new treesitter dep to the editor package) and C/C++. Release Notes: - Fixed line comment rewrapping in golang and C/C++

cla-bot Bot added the cla-signed The user has signed the Contributor License Agreement label Feb 9, 2026

Add action to toggle block comments

4c06616

ozacod force-pushed the toggle-block branch from 916d890 to 4c06616 Compare February 9, 2026 01:37

ozacod added 2 commits February 9, 2026 21:08

fmt commit.

80c7044

Merge remote-tracking branch 'origin/main' into toggle-block

89447ef

ozacod added 2 commits February 10, 2026 14:53

keybindings for editor and vim mode are added.

72b3371

cargo fmt.

7ab6c4a

ozacod added 5 commits February 10, 2026 21:25

gb$ fix.

5d9666d

gbc fix.

c97474f

visual mode overflow fix.

f899435

cargo fmt

ad5ebb3

simplified implementation

d0a82d7

Merge remote-tracking branch 'origin/main' into toggle-block

df579c8

fixed empty line block comment panic.

291aae5

ozacod marked this pull request as draft February 10, 2026 23:16

ozacod marked this pull request as ready for review February 11, 2026 12:06

fix for gbj

0489d99

ozacod added 2 commits February 11, 2026 17:03

cargo fmt

c90de9d

Merge remote-tracking branch 'origin/main' into toggle-block

34c0dce

removed redundant tests.

fd984fd

bajrangCoder mentioned this pull request Feb 26, 2026

Add line comment config bajrangCoder/zed-scss#12

Open

SomeoneToIgnore self-assigned this Mar 24, 2026

SomeoneToIgnore requested changes Mar 27, 2026

View reviewed changes

editor: move early continues above end_point adjustment in toggle_blo…

782d903

…ck_comments

ozacod force-pushed the toggle-block branch from df776b9 to 782d903 Compare March 27, 2026 17:13

ozacod added 6 commits March 27, 2026 20:27

editor: use snapshot offset methods for block comment position conver…

9028230

…sion and add Unicode tests

languages: align block_comment tab_size to 1 to match documentation_c…

250abb6

…omment

vim: add test_toggle_block_comments and expand selection to full line…

ba2698b

…s for visual line mode

editor: remove vim-specific end_point adjustment from core toggle_blo…

8c8bb61

…ck_comments; handle visual line mode in vim layer

Merge remote-tracking branch 'origin/main' into toggle-block

340a8a2

Merge remote-tracking branch 'origin/main' into toggle-block

7b42bf8

fix: move_with closures and add visual mode toggle block comment tests

3aabdde

ozacod added 4 commits March 28, 2026 02:06

fmt fix

02dcd09

fix: prefix for rust block comment

38d88a0

fix: order of initialization

40b9811

refactor: change default keybindings

c995d35

SomeoneToIgnore approved these changes Apr 8, 2026

View reviewed changes

SomeoneToIgnore merged commit 525f10a into zed-industries:main Apr 8, 2026
30 checks passed

jansol mentioned this pull request Apr 14, 2026

Better support for C style multiline comments #13318

Closed

5 tasks

zerowidth mentioned this pull request Apr 26, 2026

Fix line comment rewrap in golang and C/C++ #54931

Merged

5 tasks

Uh oh!

Conversation

ozacod commented Feb 9, 2026

Testing

Uh oh!

ozacod commented Feb 9, 2026

Uh oh!

niekdomi commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ozacod commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niekdomi commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niekdomi commented Feb 10, 2026

Uh oh!

ozacod commented Feb 10, 2026

Uh oh!

niekdomi commented Feb 10, 2026

Uh oh!

ozacod commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ozacod commented Feb 11, 2026

Uh oh!

niekdomi commented Feb 11, 2026

Uh oh!

ozacod commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niekdomi commented Feb 11, 2026

Uh oh!

SomeoneToIgnore left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ozacod commented Mar 27, 2026

Uh oh!

ConradIrwin commented Mar 27, 2026

Uh oh!

ozacod commented Apr 2, 2026

Uh oh!

SomeoneToIgnore left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

niekdomi commented Feb 10, 2026 •

edited

Loading

ozacod commented Feb 10, 2026 •

edited

Loading

niekdomi commented Feb 10, 2026 •

edited

Loading

ozacod commented Feb 10, 2026 •

edited

Loading

ozacod commented Feb 11, 2026 •

edited

Loading